Class Client

Hierarchy

  • Client

Constructors

constructor

Properties

asyncSearch async_search autoscaling cat ccr cluster connectionPool danglingIndices dangling_indices enrich eql features graph helpers ilm indices ingest license logstash migration ml monitoring nodes rollup searchableSnapshots searchable_snapshots security serializer slm snapshot sql ssl tasks textStructure text_structure transform transport watcher xpack

Methods

bulk child clearScroll clear_scroll close closePointInTime close_point_in_time count create delete deleteByQuery deleteByQueryRethrottle deleteScript delete_by_query delete_by_query_rethrottle delete_script emit exists existsSource exists_source explain extend fieldCaps field_caps get getScript getScriptContext getScriptLanguages getSource get_script get_script_context get_script_languages get_source index info mget msearch msearchTemplate msearch_template mtermvectors off on once openPointInTime open_point_in_time ping putScript put_script rankEval rank_eval reindex reindexRethrottle reindex_rethrottle renderSearchTemplate render_search_template scriptsPainlessExecute scripts_painless_execute scroll search searchShards searchTemplate search_shards search_template termvectors update updateByQuery updateByQueryRethrottle update_by_query update_by_query_rethrottle

Constructors

constructor

Properties

asyncSearch

asyncSearch: { delete: any; get: any; status: any; submit: any }

Type declaration

  • delete:function
    • delete<TResponse, TContext>(params?: AsyncSearchDelete, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: AsyncSearchDelete, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: AsyncSearchDelete, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: AsyncSearchDelete
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get:function
    • get<TResponse, TContext>(params?: AsyncSearchGet, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: AsyncSearchGet
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: AsyncSearchGet, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: AsyncSearchGet, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: AsyncSearchGet
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • status:function
    • status<TResponse, TContext>(params?: AsyncSearchStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • status<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • status<TResponse, TContext>(params: AsyncSearchStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • status<TResponse, TContext>(params: AsyncSearchStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: AsyncSearchStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • submit:function
    • submit<TResponse, TRequestBody, TContext>(params?: AsyncSearchSubmit<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: AsyncSearchSubmit<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • submit<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • submit<TResponse, TRequestBody, TContext>(params: AsyncSearchSubmit<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • submit<TResponse, TRequestBody, TContext>(params: AsyncSearchSubmit<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: AsyncSearchSubmit<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

async_search

async_search: { delete: any; get: any; status: any; submit: any }

Type declaration

  • delete:function
    • delete<TResponse, TContext>(params?: AsyncSearchDelete, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: AsyncSearchDelete, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: AsyncSearchDelete, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: AsyncSearchDelete
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get:function
    • get<TResponse, TContext>(params?: AsyncSearchGet, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: AsyncSearchGet
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: AsyncSearchGet, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: AsyncSearchGet, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: AsyncSearchGet
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • status:function
    • status<TResponse, TContext>(params?: AsyncSearchStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • status<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • status<TResponse, TContext>(params: AsyncSearchStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • status<TResponse, TContext>(params: AsyncSearchStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: AsyncSearchStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • submit:function
    • submit<TResponse, TRequestBody, TContext>(params?: AsyncSearchSubmit<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: AsyncSearchSubmit<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • submit<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • submit<TResponse, TRequestBody, TContext>(params: AsyncSearchSubmit<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • submit<TResponse, TRequestBody, TContext>(params: AsyncSearchSubmit<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: AsyncSearchSubmit<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

autoscaling

autoscaling: { deleteAutoscalingPolicy: any; delete_autoscaling_policy: any; getAutoscalingCapacity: any; getAutoscalingPolicy: any; get_autoscaling_capacity: any; get_autoscaling_policy: any; putAutoscalingPolicy: any; put_autoscaling_policy: any }

Type declaration

  • deleteAutoscalingPolicy:function
    • deleteAutoscalingPolicy<TResponse, TContext>(params?: AutoscalingDeleteAutoscalingPolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteAutoscalingPolicy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteAutoscalingPolicy<TResponse, TContext>(params: AutoscalingDeleteAutoscalingPolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteAutoscalingPolicy<TResponse, TContext>(params: AutoscalingDeleteAutoscalingPolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_autoscaling_policy:function
    • delete_autoscaling_policy<TResponse, TContext>(params?: AutoscalingDeleteAutoscalingPolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_autoscaling_policy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_autoscaling_policy<TResponse, TContext>(params: AutoscalingDeleteAutoscalingPolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_autoscaling_policy<TResponse, TContext>(params: AutoscalingDeleteAutoscalingPolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getAutoscalingCapacity:function
    • getAutoscalingCapacity<TResponse, TContext>(params?: AutoscalingGetAutoscalingCapacity, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getAutoscalingCapacity<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getAutoscalingCapacity<TResponse, TContext>(params: AutoscalingGetAutoscalingCapacity, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getAutoscalingCapacity<TResponse, TContext>(params: AutoscalingGetAutoscalingCapacity, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getAutoscalingPolicy:function
    • getAutoscalingPolicy<TResponse, TContext>(params?: AutoscalingGetAutoscalingPolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getAutoscalingPolicy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getAutoscalingPolicy<TResponse, TContext>(params: AutoscalingGetAutoscalingPolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getAutoscalingPolicy<TResponse, TContext>(params: AutoscalingGetAutoscalingPolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_autoscaling_capacity:function
    • get_autoscaling_capacity<TResponse, TContext>(params?: AutoscalingGetAutoscalingCapacity, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_autoscaling_capacity<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_autoscaling_capacity<TResponse, TContext>(params: AutoscalingGetAutoscalingCapacity, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_autoscaling_capacity<TResponse, TContext>(params: AutoscalingGetAutoscalingCapacity, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_autoscaling_policy:function
    • get_autoscaling_policy<TResponse, TContext>(params?: AutoscalingGetAutoscalingPolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_autoscaling_policy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_autoscaling_policy<TResponse, TContext>(params: AutoscalingGetAutoscalingPolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_autoscaling_policy<TResponse, TContext>(params: AutoscalingGetAutoscalingPolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • putAutoscalingPolicy:function
    • putAutoscalingPolicy<TResponse, TRequestBody, TContext>(params?: AutoscalingPutAutoscalingPolicy<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putAutoscalingPolicy<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putAutoscalingPolicy<TResponse, TRequestBody, TContext>(params: AutoscalingPutAutoscalingPolicy<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putAutoscalingPolicy<TResponse, TRequestBody, TContext>(params: AutoscalingPutAutoscalingPolicy<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • put_autoscaling_policy:function
    • put_autoscaling_policy<TResponse, TRequestBody, TContext>(params?: AutoscalingPutAutoscalingPolicy<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_autoscaling_policy<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_autoscaling_policy<TResponse, TRequestBody, TContext>(params: AutoscalingPutAutoscalingPolicy<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_autoscaling_policy<TResponse, TRequestBody, TContext>(params: AutoscalingPutAutoscalingPolicy<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

cat

cat: { aliases: any; allocation: any; count: any; fielddata: any; health: any; help: any; indices: any; master: any; mlDataFrameAnalytics: any; mlDatafeeds: any; mlJobs: any; mlTrainedModels: any; ml_data_frame_analytics: any; ml_datafeeds: any; ml_jobs: any; ml_trained_models: any; nodeattrs: any; nodes: any; pendingTasks: any; pending_tasks: any; plugins: any; recovery: any; repositories: any; segments: any; shards: any; snapshots: any; tasks: any; templates: any; threadPool: any; thread_pool: any; transforms: any }

Type declaration

  • aliases:function
    • aliases<TResponse, TContext>(params?: CatAliases, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatAliases
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • aliases<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • aliases<TResponse, TContext>(params: CatAliases, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatAliases
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • aliases<TResponse, TContext>(params: CatAliases, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatAliases
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • allocation:function
    • allocation<TResponse, TContext>(params?: CatAllocation, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatAllocation
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • allocation<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • allocation<TResponse, TContext>(params: CatAllocation, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • allocation<TResponse, TContext>(params: CatAllocation, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatAllocation
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • count:function
    • count<TResponse, TContext>(params?: CatCount, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatCount
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • count<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • count<TResponse, TContext>(params: CatCount, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatCount
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • count<TResponse, TContext>(params: CatCount, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatCount
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • fielddata:function
    • fielddata<TResponse, TContext>(params?: CatFielddata, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatFielddata
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • fielddata<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • fielddata<TResponse, TContext>(params: CatFielddata, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatFielddata
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • fielddata<TResponse, TContext>(params: CatFielddata, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatFielddata
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • health:function
    • health<TResponse, TContext>(params?: CatHealth, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatHealth
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • health<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • health<TResponse, TContext>(params: CatHealth, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatHealth
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • health<TResponse, TContext>(params: CatHealth, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatHealth
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • help:function
    • help<TResponse, TContext>(params?: CatHelp, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatHelp
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • help<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • help<TResponse, TContext>(params: CatHelp, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatHelp
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • help<TResponse, TContext>(params: CatHelp, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatHelp
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • indices:function
    • indices<TResponse, TContext>(params?: CatIndices, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatIndices
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • indices<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • indices<TResponse, TContext>(params: CatIndices, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatIndices
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • indices<TResponse, TContext>(params: CatIndices, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatIndices
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • master:function
    • master<TResponse, TContext>(params?: CatMaster, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatMaster
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • master<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • master<TResponse, TContext>(params: CatMaster, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatMaster
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • master<TResponse, TContext>(params: CatMaster, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatMaster
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • mlDataFrameAnalytics:function
    • mlDataFrameAnalytics<TResponse, TContext>(params?: CatMlDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • mlDataFrameAnalytics<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • mlDataFrameAnalytics<TResponse, TContext>(params: CatMlDataFrameAnalytics, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • mlDataFrameAnalytics<TResponse, TContext>(params: CatMlDataFrameAnalytics, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • mlDatafeeds:function
    • mlDatafeeds<TResponse, TContext>(params?: CatMlDatafeeds, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatMlDatafeeds
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • mlDatafeeds<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • mlDatafeeds<TResponse, TContext>(params: CatMlDatafeeds, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • mlDatafeeds<TResponse, TContext>(params: CatMlDatafeeds, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatMlDatafeeds
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • mlJobs:function
    • mlJobs<TResponse, TContext>(params?: CatMlJobs, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatMlJobs
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • mlJobs<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • mlJobs<TResponse, TContext>(params: CatMlJobs, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatMlJobs
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • mlJobs<TResponse, TContext>(params: CatMlJobs, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatMlJobs
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • mlTrainedModels:function
    • mlTrainedModels<TResponse, TContext>(params?: CatMlTrainedModels, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • mlTrainedModels<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • mlTrainedModels<TResponse, TContext>(params: CatMlTrainedModels, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • mlTrainedModels<TResponse, TContext>(params: CatMlTrainedModels, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatMlTrainedModels
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • ml_data_frame_analytics:function
    • ml_data_frame_analytics<TResponse, TContext>(params?: CatMlDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • ml_data_frame_analytics<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • ml_data_frame_analytics<TResponse, TContext>(params: CatMlDataFrameAnalytics, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • ml_data_frame_analytics<TResponse, TContext>(params: CatMlDataFrameAnalytics, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • ml_datafeeds:function
    • ml_datafeeds<TResponse, TContext>(params?: CatMlDatafeeds, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatMlDatafeeds
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • ml_datafeeds<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • ml_datafeeds<TResponse, TContext>(params: CatMlDatafeeds, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • ml_datafeeds<TResponse, TContext>(params: CatMlDatafeeds, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatMlDatafeeds
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • ml_jobs:function
    • ml_jobs<TResponse, TContext>(params?: CatMlJobs, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatMlJobs
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • ml_jobs<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • ml_jobs<TResponse, TContext>(params: CatMlJobs, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatMlJobs
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • ml_jobs<TResponse, TContext>(params: CatMlJobs, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatMlJobs
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • ml_trained_models:function
    • ml_trained_models<TResponse, TContext>(params?: CatMlTrainedModels, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • ml_trained_models<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • ml_trained_models<TResponse, TContext>(params: CatMlTrainedModels, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • ml_trained_models<TResponse, TContext>(params: CatMlTrainedModels, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatMlTrainedModels
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • nodeattrs:function
    • nodeattrs<TResponse, TContext>(params?: CatNodeattrs, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatNodeattrs
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • nodeattrs<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • nodeattrs<TResponse, TContext>(params: CatNodeattrs, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatNodeattrs
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • nodeattrs<TResponse, TContext>(params: CatNodeattrs, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatNodeattrs
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • nodes:function
    • nodes<TResponse, TContext>(params?: CatNodes, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatNodes
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • nodes<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • nodes<TResponse, TContext>(params: CatNodes, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatNodes
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • nodes<TResponse, TContext>(params: CatNodes, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatNodes
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • pendingTasks:function
    • pendingTasks<TResponse, TContext>(params?: CatPendingTasks, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatPendingTasks
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • pendingTasks<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • pendingTasks<TResponse, TContext>(params: CatPendingTasks, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • pendingTasks<TResponse, TContext>(params: CatPendingTasks, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatPendingTasks
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • pending_tasks:function
    • pending_tasks<TResponse, TContext>(params?: CatPendingTasks, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatPendingTasks
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • pending_tasks<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • pending_tasks<TResponse, TContext>(params: CatPendingTasks, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • pending_tasks<TResponse, TContext>(params: CatPendingTasks, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatPendingTasks
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • plugins:function
    • plugins<TResponse, TContext>(params?: CatPlugins, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatPlugins
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • plugins<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • plugins<TResponse, TContext>(params: CatPlugins, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatPlugins
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • plugins<TResponse, TContext>(params: CatPlugins, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatPlugins
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • recovery:function
    • recovery<TResponse, TContext>(params?: CatRecovery, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatRecovery
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • recovery<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • recovery<TResponse, TContext>(params: CatRecovery, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatRecovery
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • recovery<TResponse, TContext>(params: CatRecovery, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatRecovery
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • repositories:function
    • repositories<TResponse, TContext>(params?: CatRepositories, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatRepositories
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • repositories<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • repositories<TResponse, TContext>(params: CatRepositories, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • repositories<TResponse, TContext>(params: CatRepositories, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatRepositories
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • segments:function
    • segments<TResponse, TContext>(params?: CatSegments, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatSegments
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • segments<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • segments<TResponse, TContext>(params: CatSegments, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatSegments
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • segments<TResponse, TContext>(params: CatSegments, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatSegments
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • shards:function
    • shards<TResponse, TContext>(params?: CatShards, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatShards
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • shards<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • shards<TResponse, TContext>(params: CatShards, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatShards
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • shards<TResponse, TContext>(params: CatShards, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatShards
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • snapshots:function
    • snapshots<TResponse, TContext>(params?: CatSnapshots, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatSnapshots
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • snapshots<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • snapshots<TResponse, TContext>(params: CatSnapshots, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatSnapshots
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • snapshots<TResponse, TContext>(params: CatSnapshots, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatSnapshots
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • tasks:function
    • tasks<TResponse, TContext>(params?: CatTasks, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatTasks
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • tasks<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • tasks<TResponse, TContext>(params: CatTasks, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatTasks
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • tasks<TResponse, TContext>(params: CatTasks, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatTasks
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • templates:function
    • templates<TResponse, TContext>(params?: CatTemplates, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatTemplates
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • templates<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • templates<TResponse, TContext>(params: CatTemplates, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatTemplates
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • templates<TResponse, TContext>(params: CatTemplates, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatTemplates
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • threadPool:function
    • threadPool<TResponse, TContext>(params?: CatThreadPool, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatThreadPool
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • threadPool<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • threadPool<TResponse, TContext>(params: CatThreadPool, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • threadPool<TResponse, TContext>(params: CatThreadPool, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatThreadPool
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • thread_pool:function
    • thread_pool<TResponse, TContext>(params?: CatThreadPool, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatThreadPool
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • thread_pool<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • thread_pool<TResponse, TContext>(params: CatThreadPool, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • thread_pool<TResponse, TContext>(params: CatThreadPool, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatThreadPool
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • transforms:function
    • transforms<TResponse, TContext>(params?: CatTransforms, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CatTransforms
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • transforms<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • transforms<TResponse, TContext>(params: CatTransforms, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • transforms<TResponse, TContext>(params: CatTransforms, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CatTransforms
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

ccr

ccr: { deleteAutoFollowPattern: any; delete_auto_follow_pattern: any; follow: any; followInfo: any; followStats: any; follow_info: any; follow_stats: any; forgetFollower: any; forget_follower: any; getAutoFollowPattern: any; get_auto_follow_pattern: any; pauseAutoFollowPattern: any; pauseFollow: any; pause_auto_follow_pattern: any; pause_follow: any; putAutoFollowPattern: any; put_auto_follow_pattern: any; resumeAutoFollowPattern: any; resumeFollow: any; resume_auto_follow_pattern: any; resume_follow: any; stats: any; unfollow: any }

Type declaration

  • deleteAutoFollowPattern:function
    • deleteAutoFollowPattern<TResponse, TContext>(params?: CcrDeleteAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteAutoFollowPattern<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteAutoFollowPattern<TResponse, TContext>(params: CcrDeleteAutoFollowPattern, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteAutoFollowPattern<TResponse, TContext>(params: CcrDeleteAutoFollowPattern, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_auto_follow_pattern:function
    • delete_auto_follow_pattern<TResponse, TContext>(params?: CcrDeleteAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_auto_follow_pattern<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_auto_follow_pattern<TResponse, TContext>(params: CcrDeleteAutoFollowPattern, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_auto_follow_pattern<TResponse, TContext>(params: CcrDeleteAutoFollowPattern, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • follow:function
    • follow<TResponse, TRequestBody, TContext>(params?: CcrFollow<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrFollow<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • follow<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • follow<TResponse, TRequestBody, TContext>(params: CcrFollow<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrFollow<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • follow<TResponse, TRequestBody, TContext>(params: CcrFollow<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrFollow<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • followInfo:function
    • followInfo<TResponse, TContext>(params?: CcrFollowInfo, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrFollowInfo
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • followInfo<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • followInfo<TResponse, TContext>(params: CcrFollowInfo, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • followInfo<TResponse, TContext>(params: CcrFollowInfo, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrFollowInfo
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • followStats:function
    • followStats<TResponse, TContext>(params?: CcrFollowStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrFollowStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • followStats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • followStats<TResponse, TContext>(params: CcrFollowStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • followStats<TResponse, TContext>(params: CcrFollowStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrFollowStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • follow_info:function
    • follow_info<TResponse, TContext>(params?: CcrFollowInfo, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrFollowInfo
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • follow_info<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • follow_info<TResponse, TContext>(params: CcrFollowInfo, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • follow_info<TResponse, TContext>(params: CcrFollowInfo, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrFollowInfo
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • follow_stats:function
    • follow_stats<TResponse, TContext>(params?: CcrFollowStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrFollowStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • follow_stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • follow_stats<TResponse, TContext>(params: CcrFollowStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • follow_stats<TResponse, TContext>(params: CcrFollowStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrFollowStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • forgetFollower:function
    • forgetFollower<TResponse, TRequestBody, TContext>(params?: CcrForgetFollower<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrForgetFollower<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • forgetFollower<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • forgetFollower<TResponse, TRequestBody, TContext>(params: CcrForgetFollower<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • forgetFollower<TResponse, TRequestBody, TContext>(params: CcrForgetFollower<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrForgetFollower<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • forget_follower:function
    • forget_follower<TResponse, TRequestBody, TContext>(params?: CcrForgetFollower<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrForgetFollower<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • forget_follower<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • forget_follower<TResponse, TRequestBody, TContext>(params: CcrForgetFollower<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • forget_follower<TResponse, TRequestBody, TContext>(params: CcrForgetFollower<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrForgetFollower<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getAutoFollowPattern:function
    • getAutoFollowPattern<TResponse, TContext>(params?: CcrGetAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getAutoFollowPattern<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getAutoFollowPattern<TResponse, TContext>(params: CcrGetAutoFollowPattern, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getAutoFollowPattern<TResponse, TContext>(params: CcrGetAutoFollowPattern, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_auto_follow_pattern:function
    • get_auto_follow_pattern<TResponse, TContext>(params?: CcrGetAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_auto_follow_pattern<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_auto_follow_pattern<TResponse, TContext>(params: CcrGetAutoFollowPattern, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_auto_follow_pattern<TResponse, TContext>(params: CcrGetAutoFollowPattern, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • pauseAutoFollowPattern:function
    • pauseAutoFollowPattern<TResponse, TContext>(params?: CcrPauseAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • pauseAutoFollowPattern<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • pauseAutoFollowPattern<TResponse, TContext>(params: CcrPauseAutoFollowPattern, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • pauseAutoFollowPattern<TResponse, TContext>(params: CcrPauseAutoFollowPattern, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • pauseFollow:function
    • pauseFollow<TResponse, TContext>(params?: CcrPauseFollow, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrPauseFollow
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • pauseFollow<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • pauseFollow<TResponse, TContext>(params: CcrPauseFollow, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • pauseFollow<TResponse, TContext>(params: CcrPauseFollow, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrPauseFollow
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • pause_auto_follow_pattern:function
    • pause_auto_follow_pattern<TResponse, TContext>(params?: CcrPauseAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • pause_auto_follow_pattern<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • pause_auto_follow_pattern<TResponse, TContext>(params: CcrPauseAutoFollowPattern, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • pause_auto_follow_pattern<TResponse, TContext>(params: CcrPauseAutoFollowPattern, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • pause_follow:function
    • pause_follow<TResponse, TContext>(params?: CcrPauseFollow, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrPauseFollow
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • pause_follow<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • pause_follow<TResponse, TContext>(params: CcrPauseFollow, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • pause_follow<TResponse, TContext>(params: CcrPauseFollow, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrPauseFollow
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putAutoFollowPattern:function
    • putAutoFollowPattern<TResponse, TRequestBody, TContext>(params?: CcrPutAutoFollowPattern<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putAutoFollowPattern<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putAutoFollowPattern<TResponse, TRequestBody, TContext>(params: CcrPutAutoFollowPattern<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putAutoFollowPattern<TResponse, TRequestBody, TContext>(params: CcrPutAutoFollowPattern<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrPutAutoFollowPattern<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_auto_follow_pattern:function
    • put_auto_follow_pattern<TResponse, TRequestBody, TContext>(params?: CcrPutAutoFollowPattern<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_auto_follow_pattern<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_auto_follow_pattern<TResponse, TRequestBody, TContext>(params: CcrPutAutoFollowPattern<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_auto_follow_pattern<TResponse, TRequestBody, TContext>(params: CcrPutAutoFollowPattern<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrPutAutoFollowPattern<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • resumeAutoFollowPattern:function
    • resumeAutoFollowPattern<TResponse, TContext>(params?: CcrResumeAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • resumeAutoFollowPattern<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • resumeAutoFollowPattern<TResponse, TContext>(params: CcrResumeAutoFollowPattern, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • resumeAutoFollowPattern<TResponse, TContext>(params: CcrResumeAutoFollowPattern, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • resumeFollow:function
    • resumeFollow<TResponse, TRequestBody, TContext>(params?: CcrResumeFollow<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrResumeFollow<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • resumeFollow<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • resumeFollow<TResponse, TRequestBody, TContext>(params: CcrResumeFollow<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrResumeFollow<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • resumeFollow<TResponse, TRequestBody, TContext>(params: CcrResumeFollow<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrResumeFollow<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • resume_auto_follow_pattern:function
    • resume_auto_follow_pattern<TResponse, TContext>(params?: CcrResumeAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • resume_auto_follow_pattern<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • resume_auto_follow_pattern<TResponse, TContext>(params: CcrResumeAutoFollowPattern, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • resume_auto_follow_pattern<TResponse, TContext>(params: CcrResumeAutoFollowPattern, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • resume_follow:function
    • resume_follow<TResponse, TRequestBody, TContext>(params?: CcrResumeFollow<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrResumeFollow<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • resume_follow<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • resume_follow<TResponse, TRequestBody, TContext>(params: CcrResumeFollow<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrResumeFollow<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • resume_follow<TResponse, TRequestBody, TContext>(params: CcrResumeFollow<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrResumeFollow<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stats:function
    • stats<TResponse, TContext>(params?: CcrStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: CcrStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrStats
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: CcrStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • unfollow:function
    • unfollow<TResponse, TContext>(params?: CcrUnfollow, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: CcrUnfollow
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • unfollow<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • unfollow<TResponse, TContext>(params: CcrUnfollow, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrUnfollow
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • unfollow<TResponse, TContext>(params: CcrUnfollow, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: CcrUnfollow
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

cluster

cluster: { allocationExplain: any; allocation_explain: any; deleteComponentTemplate: any; deleteVotingConfigExclusions: any; delete_component_template: any; delete_voting_config_exclusions: any; existsComponentTemplate: any; exists_component_template: any; getComponentTemplate: any; getSettings: any; get_component_template: any; get_settings: any; health: any; pendingTasks: any; pending_tasks: any; postVotingConfigExclusions: any; post_voting_config_exclusions: any; putComponentTemplate: any; putSettings: any; put_component_template: any; put_settings: any; remoteInfo: any; remote_info: any; reroute: any; state: any; stats: any }

Type declaration

  • allocationExplain:function
    • allocationExplain<TResponse, TRequestBody, TContext>(params?: ClusterAllocationExplain<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • allocationExplain<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • allocationExplain<TResponse, TRequestBody, TContext>(params: ClusterAllocationExplain<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • allocationExplain<TResponse, TRequestBody, TContext>(params: ClusterAllocationExplain<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterAllocationExplain<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • allocation_explain:function
    • allocation_explain<TResponse, TRequestBody, TContext>(params?: ClusterAllocationExplain<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • allocation_explain<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • allocation_explain<TResponse, TRequestBody, TContext>(params: ClusterAllocationExplain<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • allocation_explain<TResponse, TRequestBody, TContext>(params: ClusterAllocationExplain<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterAllocationExplain<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteComponentTemplate:function
    • deleteComponentTemplate<TResponse, TContext>(params?: ClusterDeleteComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteComponentTemplate<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteComponentTemplate<TResponse, TContext>(params: ClusterDeleteComponentTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteComponentTemplate<TResponse, TContext>(params: ClusterDeleteComponentTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • deleteVotingConfigExclusions:function
    • deleteVotingConfigExclusions<TResponse, TContext>(params?: ClusterDeleteVotingConfigExclusions, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteVotingConfigExclusions<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteVotingConfigExclusions<TResponse, TContext>(params: ClusterDeleteVotingConfigExclusions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteVotingConfigExclusions<TResponse, TContext>(params: ClusterDeleteVotingConfigExclusions, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_component_template:function
    • delete_component_template<TResponse, TContext>(params?: ClusterDeleteComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_component_template<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_component_template<TResponse, TContext>(params: ClusterDeleteComponentTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_component_template<TResponse, TContext>(params: ClusterDeleteComponentTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_voting_config_exclusions:function
    • delete_voting_config_exclusions<TResponse, TContext>(params?: ClusterDeleteVotingConfigExclusions, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_voting_config_exclusions<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_voting_config_exclusions<TResponse, TContext>(params: ClusterDeleteVotingConfigExclusions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_voting_config_exclusions<TResponse, TContext>(params: ClusterDeleteVotingConfigExclusions, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • existsComponentTemplate:function
    • existsComponentTemplate<TResponse, TContext>(params?: ClusterExistsComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • existsComponentTemplate<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • existsComponentTemplate<TResponse, TContext>(params: ClusterExistsComponentTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • existsComponentTemplate<TResponse, TContext>(params: ClusterExistsComponentTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • exists_component_template:function
    • exists_component_template<TResponse, TContext>(params?: ClusterExistsComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • exists_component_template<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • exists_component_template<TResponse, TContext>(params: ClusterExistsComponentTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • exists_component_template<TResponse, TContext>(params: ClusterExistsComponentTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getComponentTemplate:function
    • getComponentTemplate<TResponse, TContext>(params?: ClusterGetComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getComponentTemplate<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getComponentTemplate<TResponse, TContext>(params: ClusterGetComponentTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getComponentTemplate<TResponse, TContext>(params: ClusterGetComponentTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getSettings:function
    • getSettings<TResponse, TContext>(params?: ClusterGetSettings, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getSettings<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getSettings<TResponse, TContext>(params: ClusterGetSettings, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getSettings<TResponse, TContext>(params: ClusterGetSettings, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterGetSettings
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_component_template:function
    • get_component_template<TResponse, TContext>(params?: ClusterGetComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_component_template<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_component_template<TResponse, TContext>(params: ClusterGetComponentTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_component_template<TResponse, TContext>(params: ClusterGetComponentTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_settings:function
    • get_settings<TResponse, TContext>(params?: ClusterGetSettings, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_settings<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_settings<TResponse, TContext>(params: ClusterGetSettings, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_settings<TResponse, TContext>(params: ClusterGetSettings, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterGetSettings
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • health:function
    • health<TResponse, TContext>(params?: ClusterHealth, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: ClusterHealth
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • health<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • health<TResponse, TContext>(params: ClusterHealth, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • health<TResponse, TContext>(params: ClusterHealth, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterHealth
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • pendingTasks:function
    • pendingTasks<TResponse, TContext>(params?: ClusterPendingTasks, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • pendingTasks<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • pendingTasks<TResponse, TContext>(params: ClusterPendingTasks, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • pendingTasks<TResponse, TContext>(params: ClusterPendingTasks, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterPendingTasks
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • pending_tasks:function
    • pending_tasks<TResponse, TContext>(params?: ClusterPendingTasks, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • pending_tasks<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • pending_tasks<TResponse, TContext>(params: ClusterPendingTasks, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • pending_tasks<TResponse, TContext>(params: ClusterPendingTasks, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterPendingTasks
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • postVotingConfigExclusions:function
    • postVotingConfigExclusions<TResponse, TContext>(params?: ClusterPostVotingConfigExclusions, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • postVotingConfigExclusions<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • postVotingConfigExclusions<TResponse, TContext>(params: ClusterPostVotingConfigExclusions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • postVotingConfigExclusions<TResponse, TContext>(params: ClusterPostVotingConfigExclusions, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • post_voting_config_exclusions:function
    • post_voting_config_exclusions<TResponse, TContext>(params?: ClusterPostVotingConfigExclusions, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • post_voting_config_exclusions<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • post_voting_config_exclusions<TResponse, TContext>(params: ClusterPostVotingConfigExclusions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • post_voting_config_exclusions<TResponse, TContext>(params: ClusterPostVotingConfigExclusions, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • putComponentTemplate:function
    • putComponentTemplate<TResponse, TRequestBody, TContext>(params?: ClusterPutComponentTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putComponentTemplate<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putComponentTemplate<TResponse, TRequestBody, TContext>(params: ClusterPutComponentTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putComponentTemplate<TResponse, TRequestBody, TContext>(params: ClusterPutComponentTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • putSettings:function
    • putSettings<TResponse, TRequestBody, TContext>(params?: ClusterPutSettings<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: ClusterPutSettings<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putSettings<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putSettings<TResponse, TRequestBody, TContext>(params: ClusterPutSettings<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putSettings<TResponse, TRequestBody, TContext>(params: ClusterPutSettings<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterPutSettings<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_component_template:function
    • put_component_template<TResponse, TRequestBody, TContext>(params?: ClusterPutComponentTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_component_template<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_component_template<TResponse, TRequestBody, TContext>(params: ClusterPutComponentTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_component_template<TResponse, TRequestBody, TContext>(params: ClusterPutComponentTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • put_settings:function
    • put_settings<TResponse, TRequestBody, TContext>(params?: ClusterPutSettings<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: ClusterPutSettings<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_settings<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_settings<TResponse, TRequestBody, TContext>(params: ClusterPutSettings<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_settings<TResponse, TRequestBody, TContext>(params: ClusterPutSettings<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterPutSettings<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • remoteInfo:function
    • remoteInfo<TResponse, TContext>(params?: ClusterRemoteInfo, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • remoteInfo<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • remoteInfo<TResponse, TContext>(params: ClusterRemoteInfo, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • remoteInfo<TResponse, TContext>(params: ClusterRemoteInfo, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterRemoteInfo
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • remote_info:function
    • remote_info<TResponse, TContext>(params?: ClusterRemoteInfo, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • remote_info<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • remote_info<TResponse, TContext>(params: ClusterRemoteInfo, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • remote_info<TResponse, TContext>(params: ClusterRemoteInfo, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterRemoteInfo
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • reroute:function
    • reroute<TResponse, TRequestBody, TContext>(params?: ClusterReroute<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: ClusterReroute<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • reroute<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • reroute<TResponse, TRequestBody, TContext>(params: ClusterReroute<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterReroute<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • reroute<TResponse, TRequestBody, TContext>(params: ClusterReroute<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterReroute<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • state:function
    • state<TResponse, TContext>(params?: ClusterState, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: ClusterState
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • state<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • state<TResponse, TContext>(params: ClusterState, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterState
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • state<TResponse, TContext>(params: ClusterState, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterState
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stats:function
    • stats<TResponse, TContext>(params?: ClusterStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: ClusterStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: ClusterStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterStats
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: ClusterStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: ClusterStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

connectionPool

connectionPool: ConnectionPool

danglingIndices

danglingIndices: { deleteDanglingIndex: any; delete_dangling_index: any; importDanglingIndex: any; import_dangling_index: any; listDanglingIndices: any; list_dangling_indices: any }

Type declaration

  • deleteDanglingIndex:function
    • deleteDanglingIndex<TResponse, TContext>(params?: DanglingIndicesDeleteDanglingIndex, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteDanglingIndex<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteDanglingIndex<TResponse, TContext>(params: DanglingIndicesDeleteDanglingIndex, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteDanglingIndex<TResponse, TContext>(params: DanglingIndicesDeleteDanglingIndex, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_dangling_index:function
    • delete_dangling_index<TResponse, TContext>(params?: DanglingIndicesDeleteDanglingIndex, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_dangling_index<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_dangling_index<TResponse, TContext>(params: DanglingIndicesDeleteDanglingIndex, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_dangling_index<TResponse, TContext>(params: DanglingIndicesDeleteDanglingIndex, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • importDanglingIndex:function
    • importDanglingIndex<TResponse, TContext>(params?: DanglingIndicesImportDanglingIndex, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • importDanglingIndex<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • importDanglingIndex<TResponse, TContext>(params: DanglingIndicesImportDanglingIndex, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • importDanglingIndex<TResponse, TContext>(params: DanglingIndicesImportDanglingIndex, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • import_dangling_index:function
    • import_dangling_index<TResponse, TContext>(params?: DanglingIndicesImportDanglingIndex, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • import_dangling_index<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • import_dangling_index<TResponse, TContext>(params: DanglingIndicesImportDanglingIndex, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • import_dangling_index<TResponse, TContext>(params: DanglingIndicesImportDanglingIndex, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • listDanglingIndices:function
    • listDanglingIndices<TResponse, TContext>(params?: DanglingIndicesListDanglingIndices, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • listDanglingIndices<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • listDanglingIndices<TResponse, TContext>(params: DanglingIndicesListDanglingIndices, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • listDanglingIndices<TResponse, TContext>(params: DanglingIndicesListDanglingIndices, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • list_dangling_indices:function
    • list_dangling_indices<TResponse, TContext>(params?: DanglingIndicesListDanglingIndices, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • list_dangling_indices<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • list_dangling_indices<TResponse, TContext>(params: DanglingIndicesListDanglingIndices, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • list_dangling_indices<TResponse, TContext>(params: DanglingIndicesListDanglingIndices, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

dangling_indices

dangling_indices: { deleteDanglingIndex: any; delete_dangling_index: any; importDanglingIndex: any; import_dangling_index: any; listDanglingIndices: any; list_dangling_indices: any }

Type declaration

  • deleteDanglingIndex:function
    • deleteDanglingIndex<TResponse, TContext>(params?: DanglingIndicesDeleteDanglingIndex, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteDanglingIndex<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteDanglingIndex<TResponse, TContext>(params: DanglingIndicesDeleteDanglingIndex, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteDanglingIndex<TResponse, TContext>(params: DanglingIndicesDeleteDanglingIndex, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_dangling_index:function
    • delete_dangling_index<TResponse, TContext>(params?: DanglingIndicesDeleteDanglingIndex, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_dangling_index<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_dangling_index<TResponse, TContext>(params: DanglingIndicesDeleteDanglingIndex, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_dangling_index<TResponse, TContext>(params: DanglingIndicesDeleteDanglingIndex, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • importDanglingIndex:function
    • importDanglingIndex<TResponse, TContext>(params?: DanglingIndicesImportDanglingIndex, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • importDanglingIndex<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • importDanglingIndex<TResponse, TContext>(params: DanglingIndicesImportDanglingIndex, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • importDanglingIndex<TResponse, TContext>(params: DanglingIndicesImportDanglingIndex, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • import_dangling_index:function
    • import_dangling_index<TResponse, TContext>(params?: DanglingIndicesImportDanglingIndex, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • import_dangling_index<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • import_dangling_index<TResponse, TContext>(params: DanglingIndicesImportDanglingIndex, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • import_dangling_index<TResponse, TContext>(params: DanglingIndicesImportDanglingIndex, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • listDanglingIndices:function
    • listDanglingIndices<TResponse, TContext>(params?: DanglingIndicesListDanglingIndices, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • listDanglingIndices<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • listDanglingIndices<TResponse, TContext>(params: DanglingIndicesListDanglingIndices, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • listDanglingIndices<TResponse, TContext>(params: DanglingIndicesListDanglingIndices, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • list_dangling_indices:function
    • list_dangling_indices<TResponse, TContext>(params?: DanglingIndicesListDanglingIndices, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • list_dangling_indices<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • list_dangling_indices<TResponse, TContext>(params: DanglingIndicesListDanglingIndices, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • list_dangling_indices<TResponse, TContext>(params: DanglingIndicesListDanglingIndices, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

enrich

enrich: { deletePolicy: any; delete_policy: any; executePolicy: any; execute_policy: any; getPolicy: any; get_policy: any; putPolicy: any; put_policy: any; stats: any }

Type declaration

  • deletePolicy:function
    • deletePolicy<TResponse, TContext>(params?: EnrichDeletePolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deletePolicy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deletePolicy<TResponse, TContext>(params: EnrichDeletePolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deletePolicy<TResponse, TContext>(params: EnrichDeletePolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichDeletePolicy
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_policy:function
    • delete_policy<TResponse, TContext>(params?: EnrichDeletePolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_policy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_policy<TResponse, TContext>(params: EnrichDeletePolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_policy<TResponse, TContext>(params: EnrichDeletePolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichDeletePolicy
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • executePolicy:function
    • executePolicy<TResponse, TContext>(params?: EnrichExecutePolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • executePolicy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • executePolicy<TResponse, TContext>(params: EnrichExecutePolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • executePolicy<TResponse, TContext>(params: EnrichExecutePolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichExecutePolicy
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • execute_policy:function
    • execute_policy<TResponse, TContext>(params?: EnrichExecutePolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • execute_policy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • execute_policy<TResponse, TContext>(params: EnrichExecutePolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • execute_policy<TResponse, TContext>(params: EnrichExecutePolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichExecutePolicy
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getPolicy:function
    • getPolicy<TResponse, TContext>(params?: EnrichGetPolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: EnrichGetPolicy
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getPolicy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getPolicy<TResponse, TContext>(params: EnrichGetPolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getPolicy<TResponse, TContext>(params: EnrichGetPolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichGetPolicy
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_policy:function
    • get_policy<TResponse, TContext>(params?: EnrichGetPolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: EnrichGetPolicy
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_policy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_policy<TResponse, TContext>(params: EnrichGetPolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_policy<TResponse, TContext>(params: EnrichGetPolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichGetPolicy
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putPolicy:function
    • putPolicy<TResponse, TRequestBody, TContext>(params?: EnrichPutPolicy<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: EnrichPutPolicy<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putPolicy<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putPolicy<TResponse, TRequestBody, TContext>(params: EnrichPutPolicy<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichPutPolicy<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putPolicy<TResponse, TRequestBody, TContext>(params: EnrichPutPolicy<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichPutPolicy<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_policy:function
    • put_policy<TResponse, TRequestBody, TContext>(params?: EnrichPutPolicy<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: EnrichPutPolicy<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_policy<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_policy<TResponse, TRequestBody, TContext>(params: EnrichPutPolicy<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichPutPolicy<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_policy<TResponse, TRequestBody, TContext>(params: EnrichPutPolicy<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichPutPolicy<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stats:function
    • stats<TResponse, TContext>(params?: EnrichStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: EnrichStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: EnrichStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichStats
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: EnrichStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EnrichStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

eql

eql: { delete: any; get: any; getStatus: any; get_status: any; search: any }

Type declaration

  • delete:function
    • delete<TResponse, TContext>(params?: EqlDelete, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: EqlDelete
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: EqlDelete, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EqlDelete
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: EqlDelete, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EqlDelete
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get:function
    • get<TResponse, TContext>(params?: EqlGet, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: EqlGet
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: EqlGet, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EqlGet
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: EqlGet, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EqlGet
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getStatus:function
    • getStatus<TResponse, TContext>(params?: EqlGetStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: EqlGetStatus
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getStatus<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getStatus<TResponse, TContext>(params: EqlGetStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EqlGetStatus
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getStatus<TResponse, TContext>(params: EqlGetStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EqlGetStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_status:function
    • get_status<TResponse, TContext>(params?: EqlGetStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: EqlGetStatus
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_status<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_status<TResponse, TContext>(params: EqlGetStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EqlGetStatus
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_status<TResponse, TContext>(params: EqlGetStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EqlGetStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • search:function
    • search<TResponse, TRequestBody, TContext>(params?: EqlSearch<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: EqlSearch<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • search<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • search<TResponse, TRequestBody, TContext>(params: EqlSearch<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EqlSearch<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • search<TResponse, TRequestBody, TContext>(params: EqlSearch<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: EqlSearch<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

features

features: { getFeatures: any; get_features: any }

Type declaration

  • getFeatures:function
    • getFeatures<TResponse, TContext>(params?: FeaturesGetFeatures, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getFeatures<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getFeatures<TResponse, TContext>(params: FeaturesGetFeatures, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getFeatures<TResponse, TContext>(params: FeaturesGetFeatures, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: FeaturesGetFeatures
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_features:function
    • get_features<TResponse, TContext>(params?: FeaturesGetFeatures, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_features<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_features<TResponse, TContext>(params: FeaturesGetFeatures, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_features<TResponse, TContext>(params: FeaturesGetFeatures, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: FeaturesGetFeatures
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

graph

graph: { explore: any }

Type declaration

  • explore:function
    • explore<TResponse, TRequestBody, TContext>(params?: GraphExplore<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: GraphExplore<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • explore<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • explore<TResponse, TRequestBody, TContext>(params: GraphExplore<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: GraphExplore<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • explore<TResponse, TRequestBody, TContext>(params: GraphExplore<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: GraphExplore<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

helpers

helpers: default

ilm

ilm: { deleteLifecycle: any; delete_lifecycle: any; explainLifecycle: any; explain_lifecycle: any; getLifecycle: any; getStatus: any; get_lifecycle: any; get_status: any; moveToStep: any; move_to_step: any; putLifecycle: any; put_lifecycle: any; removePolicy: any; remove_policy: any; retry: any; start: any; stop: any }

Type declaration

  • deleteLifecycle:function
    • deleteLifecycle<TResponse, TContext>(params?: IlmDeleteLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteLifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteLifecycle<TResponse, TContext>(params: IlmDeleteLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteLifecycle<TResponse, TContext>(params: IlmDeleteLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmDeleteLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_lifecycle:function
    • delete_lifecycle<TResponse, TContext>(params?: IlmDeleteLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_lifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_lifecycle<TResponse, TContext>(params: IlmDeleteLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_lifecycle<TResponse, TContext>(params: IlmDeleteLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmDeleteLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • explainLifecycle:function
    • explainLifecycle<TResponse, TContext>(params?: IlmExplainLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • explainLifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • explainLifecycle<TResponse, TContext>(params: IlmExplainLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • explainLifecycle<TResponse, TContext>(params: IlmExplainLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmExplainLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • explain_lifecycle:function
    • explain_lifecycle<TResponse, TContext>(params?: IlmExplainLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • explain_lifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • explain_lifecycle<TResponse, TContext>(params: IlmExplainLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • explain_lifecycle<TResponse, TContext>(params: IlmExplainLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmExplainLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getLifecycle:function
    • getLifecycle<TResponse, TContext>(params?: IlmGetLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmGetLifecycle
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getLifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getLifecycle<TResponse, TContext>(params: IlmGetLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getLifecycle<TResponse, TContext>(params: IlmGetLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmGetLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getStatus:function
    • getStatus<TResponse, TContext>(params?: IlmGetStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmGetStatus
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getStatus<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getStatus<TResponse, TContext>(params: IlmGetStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmGetStatus
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getStatus<TResponse, TContext>(params: IlmGetStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmGetStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_lifecycle:function
    • get_lifecycle<TResponse, TContext>(params?: IlmGetLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmGetLifecycle
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_lifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_lifecycle<TResponse, TContext>(params: IlmGetLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_lifecycle<TResponse, TContext>(params: IlmGetLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmGetLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_status:function
    • get_status<TResponse, TContext>(params?: IlmGetStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmGetStatus
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_status<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_status<TResponse, TContext>(params: IlmGetStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmGetStatus
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_status<TResponse, TContext>(params: IlmGetStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmGetStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • moveToStep:function
    • moveToStep<TResponse, TRequestBody, TContext>(params?: IlmMoveToStep<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmMoveToStep<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • moveToStep<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • moveToStep<TResponse, TRequestBody, TContext>(params: IlmMoveToStep<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmMoveToStep<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • moveToStep<TResponse, TRequestBody, TContext>(params: IlmMoveToStep<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmMoveToStep<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • move_to_step:function
    • move_to_step<TResponse, TRequestBody, TContext>(params?: IlmMoveToStep<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmMoveToStep<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • move_to_step<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • move_to_step<TResponse, TRequestBody, TContext>(params: IlmMoveToStep<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmMoveToStep<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • move_to_step<TResponse, TRequestBody, TContext>(params: IlmMoveToStep<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmMoveToStep<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putLifecycle:function
    • putLifecycle<TResponse, TRequestBody, TContext>(params?: IlmPutLifecycle<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmPutLifecycle<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putLifecycle<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putLifecycle<TResponse, TRequestBody, TContext>(params: IlmPutLifecycle<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmPutLifecycle<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putLifecycle<TResponse, TRequestBody, TContext>(params: IlmPutLifecycle<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmPutLifecycle<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_lifecycle:function
    • put_lifecycle<TResponse, TRequestBody, TContext>(params?: IlmPutLifecycle<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmPutLifecycle<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_lifecycle<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_lifecycle<TResponse, TRequestBody, TContext>(params: IlmPutLifecycle<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmPutLifecycle<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_lifecycle<TResponse, TRequestBody, TContext>(params: IlmPutLifecycle<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmPutLifecycle<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • removePolicy:function
    • removePolicy<TResponse, TContext>(params?: IlmRemovePolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmRemovePolicy
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • removePolicy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • removePolicy<TResponse, TContext>(params: IlmRemovePolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • removePolicy<TResponse, TContext>(params: IlmRemovePolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmRemovePolicy
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • remove_policy:function
    • remove_policy<TResponse, TContext>(params?: IlmRemovePolicy, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmRemovePolicy
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • remove_policy<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • remove_policy<TResponse, TContext>(params: IlmRemovePolicy, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • remove_policy<TResponse, TContext>(params: IlmRemovePolicy, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmRemovePolicy
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • retry:function
    • retry<TResponse, TContext>(params?: IlmRetry, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmRetry
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • retry<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • retry<TResponse, TContext>(params: IlmRetry, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmRetry
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • retry<TResponse, TContext>(params: IlmRetry, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmRetry
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • start:function
    • start<TResponse, TContext>(params?: IlmStart, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmStart
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • start<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start<TResponse, TContext>(params: IlmStart, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmStart
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start<TResponse, TContext>(params: IlmStart, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmStart
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stop:function
    • stop<TResponse, TContext>(params?: IlmStop, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IlmStop
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stop<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop<TResponse, TContext>(params: IlmStop, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmStop
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop<TResponse, TContext>(params: IlmStop, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IlmStop
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

indices

indices: { addBlock: any; add_block: any; analyze: any; clearCache: any; clear_cache: any; clone: any; close: any; create: any; createDataStream: any; create_data_stream: any; dataStreamsStats: any; data_streams_stats: any; delete: any; deleteAlias: any; deleteDataStream: any; deleteIndexTemplate: any; deleteTemplate: any; delete_alias: any; delete_data_stream: any; delete_index_template: any; delete_template: any; exists: any; existsAlias: any; existsIndexTemplate: any; existsTemplate: any; existsType: any; exists_alias: any; exists_index_template: any; exists_template: any; exists_type: any; flush: any; flushSynced: any; flush_synced: any; forcemerge: any; freeze: any; get: any; getAlias: any; getDataStream: any; getFieldMapping: any; getIndexTemplate: any; getMapping: any; getSettings: any; getTemplate: any; getUpgrade: any; get_alias: any; get_data_stream: any; get_field_mapping: any; get_index_template: any; get_mapping: any; get_settings: any; get_template: any; get_upgrade: any; migrateToDataStream: any; migrate_to_data_stream: any; open: any; promoteDataStream: any; promote_data_stream: any; putAlias: any; putIndexTemplate: any; putMapping: any; putSettings: any; putTemplate: any; put_alias: any; put_index_template: any; put_mapping: any; put_settings: any; put_template: any; recovery: any; refresh: any; reloadSearchAnalyzers: any; reload_search_analyzers: any; resolveIndex: any; resolve_index: any; rollover: any; segments: any; shardStores: any; shard_stores: any; shrink: any; simulateIndexTemplate: any; simulateTemplate: any; simulate_index_template: any; simulate_template: any; split: any; stats: any; unfreeze: any; updateAliases: any; update_aliases: any; upgrade: any; validateQuery: any; validate_query: any }

Type declaration

  • addBlock:function
    • addBlock<TResponse, TContext>(params?: IndicesAddBlock, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesAddBlock
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • addBlock<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • addBlock<TResponse, TContext>(params: IndicesAddBlock, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • addBlock<TResponse, TContext>(params: IndicesAddBlock, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesAddBlock
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • add_block:function
    • add_block<TResponse, TContext>(params?: IndicesAddBlock, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesAddBlock
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • add_block<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • add_block<TResponse, TContext>(params: IndicesAddBlock, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • add_block<TResponse, TContext>(params: IndicesAddBlock, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesAddBlock
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • analyze:function
    • analyze<TResponse, TRequestBody, TContext>(params?: IndicesAnalyze<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesAnalyze<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • analyze<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • analyze<TResponse, TRequestBody, TContext>(params: IndicesAnalyze<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesAnalyze<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • analyze<TResponse, TRequestBody, TContext>(params: IndicesAnalyze<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesAnalyze<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • clearCache:function
    • clearCache<TResponse, TContext>(params?: IndicesClearCache, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clearCache<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clearCache<TResponse, TContext>(params: IndicesClearCache, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clearCache<TResponse, TContext>(params: IndicesClearCache, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesClearCache
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • clear_cache:function
    • clear_cache<TResponse, TContext>(params?: IndicesClearCache, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clear_cache<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clear_cache<TResponse, TContext>(params: IndicesClearCache, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clear_cache<TResponse, TContext>(params: IndicesClearCache, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesClearCache
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • clone:function
    • clone<TResponse, TRequestBody, TContext>(params?: IndicesClone<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesClone<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clone<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clone<TResponse, TRequestBody, TContext>(params: IndicesClone<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesClone<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clone<TResponse, TRequestBody, TContext>(params: IndicesClone<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesClone<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • close:function
    • close<TResponse, TContext>(params?: IndicesClose, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesClose
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • close<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • close<TResponse, TContext>(params: IndicesClose, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesClose
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • close<TResponse, TContext>(params: IndicesClose, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesClose
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • create:function
    • create<TResponse, TRequestBody, TContext>(params?: IndicesCreate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesCreate<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • create<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • create<TResponse, TRequestBody, TContext>(params: IndicesCreate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesCreate<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • create<TResponse, TRequestBody, TContext>(params: IndicesCreate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesCreate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • createDataStream:function
    • createDataStream<TResponse, TContext>(params?: IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • createDataStream<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • createDataStream<TResponse, TContext>(params: IndicesCreateDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • createDataStream<TResponse, TContext>(params: IndicesCreateDataStream, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • create_data_stream:function
    • create_data_stream<TResponse, TContext>(params?: IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • create_data_stream<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • create_data_stream<TResponse, TContext>(params: IndicesCreateDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • create_data_stream<TResponse, TContext>(params: IndicesCreateDataStream, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • dataStreamsStats:function
    • dataStreamsStats<TResponse, TContext>(params?: IndicesDataStreamsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • dataStreamsStats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • dataStreamsStats<TResponse, TContext>(params: IndicesDataStreamsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • dataStreamsStats<TResponse, TContext>(params: IndicesDataStreamsStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • data_streams_stats:function
    • data_streams_stats<TResponse, TContext>(params?: IndicesDataStreamsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • data_streams_stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • data_streams_stats<TResponse, TContext>(params: IndicesDataStreamsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • data_streams_stats<TResponse, TContext>(params: IndicesDataStreamsStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete:function
    • delete<TResponse, TContext>(params?: IndicesDelete, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesDelete
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: IndicesDelete, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: IndicesDelete, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesDelete
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteAlias:function
    • deleteAlias<TResponse, TContext>(params?: IndicesDeleteAlias, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteAlias<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteAlias<TResponse, TContext>(params: IndicesDeleteAlias, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteAlias<TResponse, TContext>(params: IndicesDeleteAlias, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesDeleteAlias
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteDataStream:function
    • deleteDataStream<TResponse, TContext>(params?: IndicesDeleteDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteDataStream<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteDataStream<TResponse, TContext>(params: IndicesDeleteDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteDataStream<TResponse, TContext>(params: IndicesDeleteDataStream, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • deleteIndexTemplate:function
    • deleteIndexTemplate<TResponse, TContext>(params?: IndicesDeleteIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteIndexTemplate<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteIndexTemplate<TResponse, TContext>(params: IndicesDeleteIndexTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteIndexTemplate<TResponse, TContext>(params: IndicesDeleteIndexTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • deleteTemplate:function
    • deleteTemplate<TResponse, TContext>(params?: IndicesDeleteTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteTemplate<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteTemplate<TResponse, TContext>(params: IndicesDeleteTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteTemplate<TResponse, TContext>(params: IndicesDeleteTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesDeleteTemplate
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_alias:function
    • delete_alias<TResponse, TContext>(params?: IndicesDeleteAlias, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_alias<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_alias<TResponse, TContext>(params: IndicesDeleteAlias, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_alias<TResponse, TContext>(params: IndicesDeleteAlias, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesDeleteAlias
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_data_stream:function
    • delete_data_stream<TResponse, TContext>(params?: IndicesDeleteDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_data_stream<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_data_stream<TResponse, TContext>(params: IndicesDeleteDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_data_stream<TResponse, TContext>(params: IndicesDeleteDataStream, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_index_template:function
    • delete_index_template<TResponse, TContext>(params?: IndicesDeleteIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_index_template<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_index_template<TResponse, TContext>(params: IndicesDeleteIndexTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_index_template<TResponse, TContext>(params: IndicesDeleteIndexTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_template:function
    • delete_template<TResponse, TContext>(params?: IndicesDeleteTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_template<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_template<TResponse, TContext>(params: IndicesDeleteTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_template<TResponse, TContext>(params: IndicesDeleteTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesDeleteTemplate
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • exists:function
    • exists<TResponse, TContext>(params?: IndicesExists, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesExists
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • exists<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • exists<TResponse, TContext>(params: IndicesExists, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • exists<TResponse, TContext>(params: IndicesExists, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesExists
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • existsAlias:function
    • existsAlias<TResponse, TContext>(params?: IndicesExistsAlias, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • existsAlias<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • existsAlias<TResponse, TContext>(params: IndicesExistsAlias, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • existsAlias<TResponse, TContext>(params: IndicesExistsAlias, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesExistsAlias
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • existsIndexTemplate:function
    • existsIndexTemplate<TResponse, TContext>(params?: IndicesExistsIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • existsIndexTemplate<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • existsIndexTemplate<TResponse, TContext>(params: IndicesExistsIndexTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • existsIndexTemplate<TResponse, TContext>(params: IndicesExistsIndexTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • existsTemplate:function
    • existsTemplate<TResponse, TContext>(params?: IndicesExistsTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • existsTemplate<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • existsTemplate<TResponse, TContext>(params: IndicesExistsTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • existsTemplate<TResponse, TContext>(params: IndicesExistsTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesExistsTemplate
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • existsType:function
    • existsType<TResponse, TContext>(params?: IndicesExistsType, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • existsType<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • existsType<TResponse, TContext>(params: IndicesExistsType, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • existsType<TResponse, TContext>(params: IndicesExistsType, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesExistsType
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • exists_alias:function
    • exists_alias<TResponse, TContext>(params?: IndicesExistsAlias, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • exists_alias<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • exists_alias<TResponse, TContext>(params: IndicesExistsAlias, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • exists_alias<TResponse, TContext>(params: IndicesExistsAlias, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesExistsAlias
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • exists_index_template:function
    • exists_index_template<TResponse, TContext>(params?: IndicesExistsIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • exists_index_template<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • exists_index_template<TResponse, TContext>(params: IndicesExistsIndexTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • exists_index_template<TResponse, TContext>(params: IndicesExistsIndexTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • exists_template:function
    • exists_template<TResponse, TContext>(params?: IndicesExistsTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • exists_template<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • exists_template<TResponse, TContext>(params: IndicesExistsTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • exists_template<TResponse, TContext>(params: IndicesExistsTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesExistsTemplate
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • exists_type:function
    • exists_type<TResponse, TContext>(params?: IndicesExistsType, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • exists_type<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • exists_type<TResponse, TContext>(params: IndicesExistsType, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • exists_type<TResponse, TContext>(params: IndicesExistsType, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = boolean

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesExistsType
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • flush:function
    • flush<TResponse, TContext>(params?: IndicesFlush, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesFlush
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • flush<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • flush<TResponse, TContext>(params: IndicesFlush, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesFlush
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • flush<TResponse, TContext>(params: IndicesFlush, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesFlush
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • flushSynced:function
    • flushSynced<TResponse, TContext>(params?: IndicesFlushSynced, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • flushSynced<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • flushSynced<TResponse, TContext>(params: IndicesFlushSynced, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • flushSynced<TResponse, TContext>(params: IndicesFlushSynced, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesFlushSynced
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • flush_synced:function
    • flush_synced<TResponse, TContext>(params?: IndicesFlushSynced, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • flush_synced<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • flush_synced<TResponse, TContext>(params: IndicesFlushSynced, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • flush_synced<TResponse, TContext>(params: IndicesFlushSynced, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesFlushSynced
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • forcemerge:function
    • forcemerge<TResponse, TContext>(params?: IndicesForcemerge, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • forcemerge<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • forcemerge<TResponse, TContext>(params: IndicesForcemerge, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • forcemerge<TResponse, TContext>(params: IndicesForcemerge, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesForcemerge
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • freeze:function
    • freeze<TResponse, TContext>(params?: IndicesFreeze, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesFreeze
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • freeze<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • freeze<TResponse, TContext>(params: IndicesFreeze, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • freeze<TResponse, TContext>(params: IndicesFreeze, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesFreeze
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get:function
    • get<TResponse, TContext>(params?: IndicesGet, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesGet
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: IndicesGet, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGet
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: IndicesGet, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGet
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getAlias:function
    • getAlias<TResponse, TContext>(params?: IndicesGetAlias, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesGetAlias
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getAlias<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getAlias<TResponse, TContext>(params: IndicesGetAlias, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getAlias<TResponse, TContext>(params: IndicesGetAlias, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetAlias
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getDataStream:function
    • getDataStream<TResponse, TContext>(params?: IndicesGetDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getDataStream<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getDataStream<TResponse, TContext>(params: IndicesGetDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getDataStream<TResponse, TContext>(params: IndicesGetDataStream, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetDataStream
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getFieldMapping:function
    • getFieldMapping<TResponse, TContext>(params?: IndicesGetFieldMapping, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getFieldMapping<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getFieldMapping<TResponse, TContext>(params: IndicesGetFieldMapping, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getFieldMapping<TResponse, TContext>(params: IndicesGetFieldMapping, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getIndexTemplate:function
    • getIndexTemplate<TResponse, TContext>(params?: IndicesGetIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getIndexTemplate<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getIndexTemplate<TResponse, TContext>(params: IndicesGetIndexTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getIndexTemplate<TResponse, TContext>(params: IndicesGetIndexTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getMapping:function
    • getMapping<TResponse, TContext>(params?: IndicesGetMapping, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getMapping<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getMapping<TResponse, TContext>(params: IndicesGetMapping, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getMapping<TResponse, TContext>(params: IndicesGetMapping, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetMapping
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getSettings:function
    • getSettings<TResponse, TContext>(params?: IndicesGetSettings, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getSettings<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getSettings<TResponse, TContext>(params: IndicesGetSettings, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getSettings<TResponse, TContext>(params: IndicesGetSettings, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetSettings
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getTemplate:function
    • getTemplate<TResponse, TContext>(params?: IndicesGetTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getTemplate<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getTemplate<TResponse, TContext>(params: IndicesGetTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getTemplate<TResponse, TContext>(params: IndicesGetTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetTemplate
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getUpgrade:function
    • getUpgrade<TResponse, TContext>(params?: IndicesGetUpgrade, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getUpgrade<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getUpgrade<TResponse, TContext>(params: IndicesGetUpgrade, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getUpgrade<TResponse, TContext>(params: IndicesGetUpgrade, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetUpgrade
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_alias:function
    • get_alias<TResponse, TContext>(params?: IndicesGetAlias, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesGetAlias
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_alias<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_alias<TResponse, TContext>(params: IndicesGetAlias, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_alias<TResponse, TContext>(params: IndicesGetAlias, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetAlias
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_data_stream:function
    • get_data_stream<TResponse, TContext>(params?: IndicesGetDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_data_stream<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_data_stream<TResponse, TContext>(params: IndicesGetDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_data_stream<TResponse, TContext>(params: IndicesGetDataStream, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetDataStream
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_field_mapping:function
    • get_field_mapping<TResponse, TContext>(params?: IndicesGetFieldMapping, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_field_mapping<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_field_mapping<TResponse, TContext>(params: IndicesGetFieldMapping, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_field_mapping<TResponse, TContext>(params: IndicesGetFieldMapping, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_index_template:function
    • get_index_template<TResponse, TContext>(params?: IndicesGetIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_index_template<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_index_template<TResponse, TContext>(params: IndicesGetIndexTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_index_template<TResponse, TContext>(params: IndicesGetIndexTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_mapping:function
    • get_mapping<TResponse, TContext>(params?: IndicesGetMapping, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_mapping<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_mapping<TResponse, TContext>(params: IndicesGetMapping, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_mapping<TResponse, TContext>(params: IndicesGetMapping, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetMapping
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_settings:function
    • get_settings<TResponse, TContext>(params?: IndicesGetSettings, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_settings<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_settings<TResponse, TContext>(params: IndicesGetSettings, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_settings<TResponse, TContext>(params: IndicesGetSettings, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetSettings
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_template:function
    • get_template<TResponse, TContext>(params?: IndicesGetTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_template<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_template<TResponse, TContext>(params: IndicesGetTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_template<TResponse, TContext>(params: IndicesGetTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetTemplate
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_upgrade:function
    • get_upgrade<TResponse, TContext>(params?: IndicesGetUpgrade, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_upgrade<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_upgrade<TResponse, TContext>(params: IndicesGetUpgrade, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_upgrade<TResponse, TContext>(params: IndicesGetUpgrade, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesGetUpgrade
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • migrateToDataStream:function
    • migrateToDataStream<TResponse, TContext>(params?: IndicesMigrateToDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • migrateToDataStream<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • migrateToDataStream<TResponse, TContext>(params: IndicesMigrateToDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • migrateToDataStream<TResponse, TContext>(params: IndicesMigrateToDataStream, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • migrate_to_data_stream:function
    • migrate_to_data_stream<TResponse, TContext>(params?: IndicesMigrateToDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • migrate_to_data_stream<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • migrate_to_data_stream<TResponse, TContext>(params: IndicesMigrateToDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • migrate_to_data_stream<TResponse, TContext>(params: IndicesMigrateToDataStream, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • open:function
    • open<TResponse, TContext>(params?: IndicesOpen, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesOpen
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • open<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • open<TResponse, TContext>(params: IndicesOpen, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesOpen
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • open<TResponse, TContext>(params: IndicesOpen, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesOpen
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • promoteDataStream:function
    • promoteDataStream<TResponse, TContext>(params?: IndicesPromoteDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • promoteDataStream<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • promoteDataStream<TResponse, TContext>(params: IndicesPromoteDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • promoteDataStream<TResponse, TContext>(params: IndicesPromoteDataStream, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • promote_data_stream:function
    • promote_data_stream<TResponse, TContext>(params?: IndicesPromoteDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • promote_data_stream<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • promote_data_stream<TResponse, TContext>(params: IndicesPromoteDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • promote_data_stream<TResponse, TContext>(params: IndicesPromoteDataStream, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • putAlias:function
    • putAlias<TResponse, TRequestBody, TContext>(params?: IndicesPutAlias<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesPutAlias<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putAlias<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putAlias<TResponse, TRequestBody, TContext>(params: IndicesPutAlias<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutAlias<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putAlias<TResponse, TRequestBody, TContext>(params: IndicesPutAlias<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutAlias<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putIndexTemplate:function
    • putIndexTemplate<TResponse, TRequestBody, TContext>(params?: IndicesPutIndexTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putIndexTemplate<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putIndexTemplate<TResponse, TRequestBody, TContext>(params: IndicesPutIndexTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putIndexTemplate<TResponse, TRequestBody, TContext>(params: IndicesPutIndexTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutIndexTemplate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putMapping:function
    • putMapping<TResponse, TRequestBody, TContext>(params?: IndicesPutMapping<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesPutMapping<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putMapping<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putMapping<TResponse, TRequestBody, TContext>(params: IndicesPutMapping<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putMapping<TResponse, TRequestBody, TContext>(params: IndicesPutMapping<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutMapping<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putSettings:function
    • putSettings<TResponse, TRequestBody, TContext>(params?: IndicesPutSettings<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesPutSettings<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putSettings<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putSettings<TResponse, TRequestBody, TContext>(params: IndicesPutSettings<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putSettings<TResponse, TRequestBody, TContext>(params: IndicesPutSettings<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutSettings<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putTemplate:function
    • putTemplate<TResponse, TRequestBody, TContext>(params?: IndicesPutTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesPutTemplate<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putTemplate<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putTemplate<TResponse, TRequestBody, TContext>(params: IndicesPutTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putTemplate<TResponse, TRequestBody, TContext>(params: IndicesPutTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutTemplate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_alias:function
    • put_alias<TResponse, TRequestBody, TContext>(params?: IndicesPutAlias<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesPutAlias<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_alias<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_alias<TResponse, TRequestBody, TContext>(params: IndicesPutAlias<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutAlias<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_alias<TResponse, TRequestBody, TContext>(params: IndicesPutAlias<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutAlias<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_index_template:function
    • put_index_template<TResponse, TRequestBody, TContext>(params?: IndicesPutIndexTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_index_template<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_index_template<TResponse, TRequestBody, TContext>(params: IndicesPutIndexTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_index_template<TResponse, TRequestBody, TContext>(params: IndicesPutIndexTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutIndexTemplate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_mapping:function
    • put_mapping<TResponse, TRequestBody, TContext>(params?: IndicesPutMapping<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesPutMapping<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_mapping<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_mapping<TResponse, TRequestBody, TContext>(params: IndicesPutMapping<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_mapping<TResponse, TRequestBody, TContext>(params: IndicesPutMapping<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutMapping<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_settings:function
    • put_settings<TResponse, TRequestBody, TContext>(params?: IndicesPutSettings<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesPutSettings<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_settings<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_settings<TResponse, TRequestBody, TContext>(params: IndicesPutSettings<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_settings<TResponse, TRequestBody, TContext>(params: IndicesPutSettings<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutSettings<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_template:function
    • put_template<TResponse, TRequestBody, TContext>(params?: IndicesPutTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesPutTemplate<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_template<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_template<TResponse, TRequestBody, TContext>(params: IndicesPutTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_template<TResponse, TRequestBody, TContext>(params: IndicesPutTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesPutTemplate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • recovery:function
    • recovery<TResponse, TContext>(params?: IndicesRecovery, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesRecovery
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • recovery<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • recovery<TResponse, TContext>(params: IndicesRecovery, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • recovery<TResponse, TContext>(params: IndicesRecovery, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesRecovery
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • refresh:function
    • refresh<TResponse, TContext>(params?: IndicesRefresh, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesRefresh
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • refresh<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • refresh<TResponse, TContext>(params: IndicesRefresh, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • refresh<TResponse, TContext>(params: IndicesRefresh, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesRefresh
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • reloadSearchAnalyzers:function
    • reloadSearchAnalyzers<TResponse, TContext>(params?: IndicesReloadSearchAnalyzers, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • reloadSearchAnalyzers<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • reloadSearchAnalyzers<TResponse, TContext>(params: IndicesReloadSearchAnalyzers, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • reloadSearchAnalyzers<TResponse, TContext>(params: IndicesReloadSearchAnalyzers, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • reload_search_analyzers:function
    • reload_search_analyzers<TResponse, TContext>(params?: IndicesReloadSearchAnalyzers, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • reload_search_analyzers<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • reload_search_analyzers<TResponse, TContext>(params: IndicesReloadSearchAnalyzers, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • reload_search_analyzers<TResponse, TContext>(params: IndicesReloadSearchAnalyzers, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • resolveIndex:function
    • resolveIndex<TResponse, TContext>(params?: IndicesResolveIndex, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • resolveIndex<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • resolveIndex<TResponse, TContext>(params: IndicesResolveIndex, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • resolveIndex<TResponse, TContext>(params: IndicesResolveIndex, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesResolveIndex
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • resolve_index:function
    • resolve_index<TResponse, TContext>(params?: IndicesResolveIndex, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • resolve_index<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • resolve_index<TResponse, TContext>(params: IndicesResolveIndex, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • resolve_index<TResponse, TContext>(params: IndicesResolveIndex, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesResolveIndex
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • rollover:function
    • rollover<TResponse, TRequestBody, TContext>(params?: IndicesRollover<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesRollover<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • rollover<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • rollover<TResponse, TRequestBody, TContext>(params: IndicesRollover<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesRollover<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • rollover<TResponse, TRequestBody, TContext>(params: IndicesRollover<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesRollover<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • segments:function
    • segments<TResponse, TContext>(params?: IndicesSegments, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesSegments
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • segments<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • segments<TResponse, TContext>(params: IndicesSegments, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • segments<TResponse, TContext>(params: IndicesSegments, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesSegments
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • shardStores:function
    • shardStores<TResponse, TContext>(params?: IndicesShardStores, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • shardStores<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • shardStores<TResponse, TContext>(params: IndicesShardStores, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • shardStores<TResponse, TContext>(params: IndicesShardStores, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesShardStores
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • shard_stores:function
    • shard_stores<TResponse, TContext>(params?: IndicesShardStores, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • shard_stores<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • shard_stores<TResponse, TContext>(params: IndicesShardStores, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • shard_stores<TResponse, TContext>(params: IndicesShardStores, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesShardStores
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • shrink:function
    • shrink<TResponse, TRequestBody, TContext>(params?: IndicesShrink<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesShrink<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • shrink<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • shrink<TResponse, TRequestBody, TContext>(params: IndicesShrink<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesShrink<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • shrink<TResponse, TRequestBody, TContext>(params: IndicesShrink<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesShrink<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • simulateIndexTemplate:function
    • simulateIndexTemplate<TResponse, TRequestBody, TContext>(params?: IndicesSimulateIndexTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • simulateIndexTemplate<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • simulateIndexTemplate<TResponse, TRequestBody, TContext>(params: IndicesSimulateIndexTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • simulateIndexTemplate<TResponse, TRequestBody, TContext>(params: IndicesSimulateIndexTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • simulateTemplate:function
    • simulateTemplate<TResponse, TRequestBody, TContext>(params?: IndicesSimulateTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • simulateTemplate<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • simulateTemplate<TResponse, TRequestBody, TContext>(params: IndicesSimulateTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • simulateTemplate<TResponse, TRequestBody, TContext>(params: IndicesSimulateTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesSimulateTemplate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • simulate_index_template:function
    • simulate_index_template<TResponse, TRequestBody, TContext>(params?: IndicesSimulateIndexTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • simulate_index_template<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • simulate_index_template<TResponse, TRequestBody, TContext>(params: IndicesSimulateIndexTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • simulate_index_template<TResponse, TRequestBody, TContext>(params: IndicesSimulateIndexTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • simulate_template:function
    • simulate_template<TResponse, TRequestBody, TContext>(params?: IndicesSimulateTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • simulate_template<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • simulate_template<TResponse, TRequestBody, TContext>(params: IndicesSimulateTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • simulate_template<TResponse, TRequestBody, TContext>(params: IndicesSimulateTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesSimulateTemplate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • split:function
    • split<TResponse, TRequestBody, TContext>(params?: IndicesSplit<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesSplit<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • split<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • split<TResponse, TRequestBody, TContext>(params: IndicesSplit<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesSplit<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • split<TResponse, TRequestBody, TContext>(params: IndicesSplit<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesSplit<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stats:function
    • stats<TResponse, TContext>(params?: IndicesStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: IndicesStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesStats
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: IndicesStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • unfreeze:function
    • unfreeze<TResponse, TContext>(params?: IndicesUnfreeze, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesUnfreeze
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • unfreeze<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • unfreeze<TResponse, TContext>(params: IndicesUnfreeze, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • unfreeze<TResponse, TContext>(params: IndicesUnfreeze, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesUnfreeze
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • updateAliases:function
    • updateAliases<TResponse, TRequestBody, TContext>(params?: IndicesUpdateAliases<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • updateAliases<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • updateAliases<TResponse, TRequestBody, TContext>(params: IndicesUpdateAliases<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • updateAliases<TResponse, TRequestBody, TContext>(params: IndicesUpdateAliases<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesUpdateAliases<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • update_aliases:function
    • update_aliases<TResponse, TRequestBody, TContext>(params?: IndicesUpdateAliases<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • update_aliases<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • update_aliases<TResponse, TRequestBody, TContext>(params: IndicesUpdateAliases<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • update_aliases<TResponse, TRequestBody, TContext>(params: IndicesUpdateAliases<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesUpdateAliases<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • upgrade:function
    • upgrade<TResponse, TContext>(params?: IndicesUpgrade, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IndicesUpgrade
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • upgrade<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • upgrade<TResponse, TContext>(params: IndicesUpgrade, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • upgrade<TResponse, TContext>(params: IndicesUpgrade, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesUpgrade
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • validateQuery:function
    • validateQuery<TResponse, TRequestBody, TContext>(params?: IndicesValidateQuery<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • validateQuery<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • validateQuery<TResponse, TRequestBody, TContext>(params: IndicesValidateQuery<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • validateQuery<TResponse, TRequestBody, TContext>(params: IndicesValidateQuery<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesValidateQuery<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • validate_query:function
    • validate_query<TResponse, TRequestBody, TContext>(params?: IndicesValidateQuery<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • validate_query<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • validate_query<TResponse, TRequestBody, TContext>(params: IndicesValidateQuery<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • validate_query<TResponse, TRequestBody, TContext>(params: IndicesValidateQuery<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IndicesValidateQuery<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

ingest

ingest: { deletePipeline: any; delete_pipeline: any; getPipeline: any; get_pipeline: any; processorGrok: any; processor_grok: any; putPipeline: any; put_pipeline: any; simulate: any }

Type declaration

  • deletePipeline:function
    • deletePipeline<TResponse, TContext>(params?: IngestDeletePipeline, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deletePipeline<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deletePipeline<TResponse, TContext>(params: IngestDeletePipeline, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deletePipeline<TResponse, TContext>(params: IngestDeletePipeline, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IngestDeletePipeline
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_pipeline:function
    • delete_pipeline<TResponse, TContext>(params?: IngestDeletePipeline, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_pipeline<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_pipeline<TResponse, TContext>(params: IngestDeletePipeline, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_pipeline<TResponse, TContext>(params: IngestDeletePipeline, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IngestDeletePipeline
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getPipeline:function
    • getPipeline<TResponse, TContext>(params?: IngestGetPipeline, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getPipeline<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getPipeline<TResponse, TContext>(params: IngestGetPipeline, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getPipeline<TResponse, TContext>(params: IngestGetPipeline, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IngestGetPipeline
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_pipeline:function
    • get_pipeline<TResponse, TContext>(params?: IngestGetPipeline, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_pipeline<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_pipeline<TResponse, TContext>(params: IngestGetPipeline, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_pipeline<TResponse, TContext>(params: IngestGetPipeline, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IngestGetPipeline
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • processorGrok:function
    • processorGrok<TResponse, TContext>(params?: IngestProcessorGrok, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • processorGrok<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • processorGrok<TResponse, TContext>(params: IngestProcessorGrok, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • processorGrok<TResponse, TContext>(params: IngestProcessorGrok, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IngestProcessorGrok
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • processor_grok:function
    • processor_grok<TResponse, TContext>(params?: IngestProcessorGrok, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • processor_grok<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • processor_grok<TResponse, TContext>(params: IngestProcessorGrok, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • processor_grok<TResponse, TContext>(params: IngestProcessorGrok, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IngestProcessorGrok
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putPipeline:function
    • putPipeline<TResponse, TRequestBody, TContext>(params?: IngestPutPipeline<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IngestPutPipeline<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putPipeline<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putPipeline<TResponse, TRequestBody, TContext>(params: IngestPutPipeline<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putPipeline<TResponse, TRequestBody, TContext>(params: IngestPutPipeline<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IngestPutPipeline<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_pipeline:function
    • put_pipeline<TResponse, TRequestBody, TContext>(params?: IngestPutPipeline<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IngestPutPipeline<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_pipeline<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_pipeline<TResponse, TRequestBody, TContext>(params: IngestPutPipeline<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_pipeline<TResponse, TRequestBody, TContext>(params: IngestPutPipeline<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IngestPutPipeline<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • simulate:function
    • simulate<TResponse, TRequestBody, TContext>(params?: IngestSimulate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: IngestSimulate<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • simulate<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • simulate<TResponse, TRequestBody, TContext>(params: IngestSimulate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IngestSimulate<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • simulate<TResponse, TRequestBody, TContext>(params: IngestSimulate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: IngestSimulate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

license

license: { delete: any; get: any; getBasicStatus: any; getTrialStatus: any; get_basic_status: any; get_trial_status: any; post: any; postStartBasic: any; postStartTrial: any; post_start_basic: any; post_start_trial: any }

Type declaration

  • delete:function
    • delete<TResponse, TContext>(params?: LicenseDelete, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: LicenseDelete
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: LicenseDelete, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: LicenseDelete, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicenseDelete
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get:function
    • get<TResponse, TContext>(params?: LicenseGet, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: LicenseGet
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: LicenseGet, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicenseGet
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: LicenseGet, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicenseGet
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getBasicStatus:function
    • getBasicStatus<TResponse, TContext>(params?: LicenseGetBasicStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getBasicStatus<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getBasicStatus<TResponse, TContext>(params: LicenseGetBasicStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getBasicStatus<TResponse, TContext>(params: LicenseGetBasicStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicenseGetBasicStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getTrialStatus:function
    • getTrialStatus<TResponse, TContext>(params?: LicenseGetTrialStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getTrialStatus<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getTrialStatus<TResponse, TContext>(params: LicenseGetTrialStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getTrialStatus<TResponse, TContext>(params: LicenseGetTrialStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicenseGetTrialStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_basic_status:function
    • get_basic_status<TResponse, TContext>(params?: LicenseGetBasicStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_basic_status<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_basic_status<TResponse, TContext>(params: LicenseGetBasicStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_basic_status<TResponse, TContext>(params: LicenseGetBasicStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicenseGetBasicStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_trial_status:function
    • get_trial_status<TResponse, TContext>(params?: LicenseGetTrialStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_trial_status<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_trial_status<TResponse, TContext>(params: LicenseGetTrialStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_trial_status<TResponse, TContext>(params: LicenseGetTrialStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicenseGetTrialStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • post:function
    • post<TResponse, TRequestBody, TContext>(params?: LicensePost<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: LicensePost<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • post<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • post<TResponse, TRequestBody, TContext>(params: LicensePost<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicensePost<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • post<TResponse, TRequestBody, TContext>(params: LicensePost<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicensePost<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • postStartBasic:function
    • postStartBasic<TResponse, TContext>(params?: LicensePostStartBasic, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • postStartBasic<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • postStartBasic<TResponse, TContext>(params: LicensePostStartBasic, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • postStartBasic<TResponse, TContext>(params: LicensePostStartBasic, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicensePostStartBasic
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • postStartTrial:function
    • postStartTrial<TResponse, TContext>(params?: LicensePostStartTrial, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • postStartTrial<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • postStartTrial<TResponse, TContext>(params: LicensePostStartTrial, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • postStartTrial<TResponse, TContext>(params: LicensePostStartTrial, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicensePostStartTrial
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • post_start_basic:function
    • post_start_basic<TResponse, TContext>(params?: LicensePostStartBasic, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • post_start_basic<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • post_start_basic<TResponse, TContext>(params: LicensePostStartBasic, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • post_start_basic<TResponse, TContext>(params: LicensePostStartBasic, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicensePostStartBasic
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • post_start_trial:function
    • post_start_trial<TResponse, TContext>(params?: LicensePostStartTrial, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • post_start_trial<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • post_start_trial<TResponse, TContext>(params: LicensePostStartTrial, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • post_start_trial<TResponse, TContext>(params: LicensePostStartTrial, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LicensePostStartTrial
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

logstash

logstash: { deletePipeline: any; delete_pipeline: any; getPipeline: any; get_pipeline: any; putPipeline: any; put_pipeline: any }

Type declaration

  • deletePipeline:function
    • deletePipeline<TResponse, TContext>(params?: LogstashDeletePipeline, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deletePipeline<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deletePipeline<TResponse, TContext>(params: LogstashDeletePipeline, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deletePipeline<TResponse, TContext>(params: LogstashDeletePipeline, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_pipeline:function
    • delete_pipeline<TResponse, TContext>(params?: LogstashDeletePipeline, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_pipeline<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_pipeline<TResponse, TContext>(params: LogstashDeletePipeline, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_pipeline<TResponse, TContext>(params: LogstashDeletePipeline, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getPipeline:function
    • getPipeline<TResponse, TContext>(params?: LogstashGetPipeline, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getPipeline<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getPipeline<TResponse, TContext>(params: LogstashGetPipeline, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getPipeline<TResponse, TContext>(params: LogstashGetPipeline, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LogstashGetPipeline
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_pipeline:function
    • get_pipeline<TResponse, TContext>(params?: LogstashGetPipeline, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_pipeline<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_pipeline<TResponse, TContext>(params: LogstashGetPipeline, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_pipeline<TResponse, TContext>(params: LogstashGetPipeline, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LogstashGetPipeline
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putPipeline:function
    • putPipeline<TResponse, TRequestBody, TContext>(params?: LogstashPutPipeline<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putPipeline<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putPipeline<TResponse, TRequestBody, TContext>(params: LogstashPutPipeline<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putPipeline<TResponse, TRequestBody, TContext>(params: LogstashPutPipeline<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LogstashPutPipeline<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_pipeline:function
    • put_pipeline<TResponse, TRequestBody, TContext>(params?: LogstashPutPipeline<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_pipeline<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_pipeline<TResponse, TRequestBody, TContext>(params: LogstashPutPipeline<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_pipeline<TResponse, TRequestBody, TContext>(params: LogstashPutPipeline<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: LogstashPutPipeline<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

migration

migration: { deprecations: any }

Type declaration

  • deprecations:function
    • deprecations<TResponse, TContext>(params?: MigrationDeprecations, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deprecations<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deprecations<TResponse, TContext>(params: MigrationDeprecations, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deprecations<TResponse, TContext>(params: MigrationDeprecations, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MigrationDeprecations
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

ml

ml: { closeJob: any; close_job: any; deleteCalendar: any; deleteCalendarEvent: any; deleteCalendarJob: any; deleteDataFrameAnalytics: any; deleteDatafeed: any; deleteExpiredData: any; deleteFilter: any; deleteForecast: any; deleteJob: any; deleteModelSnapshot: any; deleteTrainedModel: any; delete_calendar: any; delete_calendar_event: any; delete_calendar_job: any; delete_data_frame_analytics: any; delete_datafeed: any; delete_expired_data: any; delete_filter: any; delete_forecast: any; delete_job: any; delete_model_snapshot: any; delete_trained_model: any; estimateModelMemory: any; estimate_model_memory: any; evaluateDataFrame: any; evaluate_data_frame: any; explainDataFrameAnalytics: any; explain_data_frame_analytics: any; flushJob: any; flush_job: any; forecast: any; getBuckets: any; getCalendarEvents: any; getCalendars: any; getCategories: any; getDataFrameAnalytics: any; getDataFrameAnalyticsStats: any; getDatafeedStats: any; getDatafeeds: any; getFilters: any; getInfluencers: any; getJobStats: any; getJobs: any; getModelSnapshots: any; getOverallBuckets: any; getRecords: any; getTrainedModels: any; getTrainedModelsStats: any; get_buckets: any; get_calendar_events: any; get_calendars: any; get_categories: any; get_data_frame_analytics: any; get_data_frame_analytics_stats: any; get_datafeed_stats: any; get_datafeeds: any; get_filters: any; get_influencers: any; get_job_stats: any; get_jobs: any; get_model_snapshots: any; get_overall_buckets: any; get_records: any; get_trained_models: any; get_trained_models_stats: any; info: any; openJob: any; open_job: any; postCalendarEvents: any; postData: any; post_calendar_events: any; post_data: any; previewDatafeed: any; preview_datafeed: any; putCalendar: any; putCalendarJob: any; putDataFrameAnalytics: any; putDatafeed: any; putFilter: any; putJob: any; putTrainedModel: any; put_calendar: any; put_calendar_job: any; put_data_frame_analytics: any; put_datafeed: any; put_filter: any; put_job: any; put_trained_model: any; revertModelSnapshot: any; revert_model_snapshot: any; setUpgradeMode: any; set_upgrade_mode: any; startDataFrameAnalytics: any; startDatafeed: any; start_data_frame_analytics: any; start_datafeed: any; stopDataFrameAnalytics: any; stopDatafeed: any; stop_data_frame_analytics: any; stop_datafeed: any; updateDataFrameAnalytics: any; updateDatafeed: any; updateFilter: any; updateJob: any; updateModelSnapshot: any; update_data_frame_analytics: any; update_datafeed: any; update_filter: any; update_job: any; update_model_snapshot: any; upgradeJobSnapshot: any; upgrade_job_snapshot: any; validate: any; validateDetector: any; validate_detector: any }

Type declaration

  • closeJob:function
    • closeJob<TResponse, TRequestBody, TContext>(params?: MlCloseJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlCloseJob<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • closeJob<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • closeJob<TResponse, TRequestBody, TContext>(params: MlCloseJob<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlCloseJob<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • closeJob<TResponse, TRequestBody, TContext>(params: MlCloseJob<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlCloseJob<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • close_job:function
    • close_job<TResponse, TRequestBody, TContext>(params?: MlCloseJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlCloseJob<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • close_job<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • close_job<TResponse, TRequestBody, TContext>(params: MlCloseJob<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlCloseJob<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • close_job<TResponse, TRequestBody, TContext>(params: MlCloseJob<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlCloseJob<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteCalendar:function
    • deleteCalendar<TResponse, TContext>(params?: MlDeleteCalendar, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteCalendar<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteCalendar<TResponse, TContext>(params: MlDeleteCalendar, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteCalendar<TResponse, TContext>(params: MlDeleteCalendar, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteCalendar
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteCalendarEvent:function
    • deleteCalendarEvent<TResponse, TContext>(params?: MlDeleteCalendarEvent, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteCalendarEvent<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteCalendarEvent<TResponse, TContext>(params: MlDeleteCalendarEvent, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteCalendarEvent<TResponse, TContext>(params: MlDeleteCalendarEvent, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteCalendarEvent
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteCalendarJob:function
    • deleteCalendarJob<TResponse, TContext>(params?: MlDeleteCalendarJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteCalendarJob<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteCalendarJob<TResponse, TContext>(params: MlDeleteCalendarJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteCalendarJob<TResponse, TContext>(params: MlDeleteCalendarJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteCalendarJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteDataFrameAnalytics:function
    • deleteDataFrameAnalytics<TResponse, TContext>(params?: MlDeleteDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteDataFrameAnalytics<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteDataFrameAnalytics<TResponse, TContext>(params: MlDeleteDataFrameAnalytics, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteDataFrameAnalytics<TResponse, TContext>(params: MlDeleteDataFrameAnalytics, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • deleteDatafeed:function
    • deleteDatafeed<TResponse, TContext>(params?: MlDeleteDatafeed, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteDatafeed<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteDatafeed<TResponse, TContext>(params: MlDeleteDatafeed, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteDatafeed<TResponse, TContext>(params: MlDeleteDatafeed, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteDatafeed
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteExpiredData:function
    • deleteExpiredData<TResponse, TRequestBody, TContext>(params?: MlDeleteExpiredData<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteExpiredData<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteExpiredData<TResponse, TRequestBody, TContext>(params: MlDeleteExpiredData<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteExpiredData<TResponse, TRequestBody, TContext>(params: MlDeleteExpiredData<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteExpiredData<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteFilter:function
    • deleteFilter<TResponse, TContext>(params?: MlDeleteFilter, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlDeleteFilter
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteFilter<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteFilter<TResponse, TContext>(params: MlDeleteFilter, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteFilter<TResponse, TContext>(params: MlDeleteFilter, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteFilter
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteForecast:function
    • deleteForecast<TResponse, TContext>(params?: MlDeleteForecast, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteForecast<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteForecast<TResponse, TContext>(params: MlDeleteForecast, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteForecast<TResponse, TContext>(params: MlDeleteForecast, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteForecast
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteJob:function
    • deleteJob<TResponse, TContext>(params?: MlDeleteJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlDeleteJob
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteJob<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteJob<TResponse, TContext>(params: MlDeleteJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteJob
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteJob<TResponse, TContext>(params: MlDeleteJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteModelSnapshot:function
    • deleteModelSnapshot<TResponse, TContext>(params?: MlDeleteModelSnapshot, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteModelSnapshot<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteModelSnapshot<TResponse, TContext>(params: MlDeleteModelSnapshot, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteModelSnapshot<TResponse, TContext>(params: MlDeleteModelSnapshot, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteModelSnapshot
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteTrainedModel:function
    • deleteTrainedModel<TResponse, TContext>(params?: MlDeleteTrainedModel, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteTrainedModel<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteTrainedModel<TResponse, TContext>(params: MlDeleteTrainedModel, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteTrainedModel<TResponse, TContext>(params: MlDeleteTrainedModel, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteTrainedModel
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_calendar:function
    • delete_calendar<TResponse, TContext>(params?: MlDeleteCalendar, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_calendar<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_calendar<TResponse, TContext>(params: MlDeleteCalendar, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_calendar<TResponse, TContext>(params: MlDeleteCalendar, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteCalendar
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_calendar_event:function
    • delete_calendar_event<TResponse, TContext>(params?: MlDeleteCalendarEvent, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_calendar_event<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_calendar_event<TResponse, TContext>(params: MlDeleteCalendarEvent, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_calendar_event<TResponse, TContext>(params: MlDeleteCalendarEvent, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteCalendarEvent
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_calendar_job:function
    • delete_calendar_job<TResponse, TContext>(params?: MlDeleteCalendarJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_calendar_job<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_calendar_job<TResponse, TContext>(params: MlDeleteCalendarJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_calendar_job<TResponse, TContext>(params: MlDeleteCalendarJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteCalendarJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_data_frame_analytics:function
    • delete_data_frame_analytics<TResponse, TContext>(params?: MlDeleteDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_data_frame_analytics<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_data_frame_analytics<TResponse, TContext>(params: MlDeleteDataFrameAnalytics, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_data_frame_analytics<TResponse, TContext>(params: MlDeleteDataFrameAnalytics, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_datafeed:function
    • delete_datafeed<TResponse, TContext>(params?: MlDeleteDatafeed, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_datafeed<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_datafeed<TResponse, TContext>(params: MlDeleteDatafeed, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_datafeed<TResponse, TContext>(params: MlDeleteDatafeed, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteDatafeed
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_expired_data:function
    • delete_expired_data<TResponse, TRequestBody, TContext>(params?: MlDeleteExpiredData<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_expired_data<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_expired_data<TResponse, TRequestBody, TContext>(params: MlDeleteExpiredData<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_expired_data<TResponse, TRequestBody, TContext>(params: MlDeleteExpiredData<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteExpiredData<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_filter:function
    • delete_filter<TResponse, TContext>(params?: MlDeleteFilter, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlDeleteFilter
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_filter<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_filter<TResponse, TContext>(params: MlDeleteFilter, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_filter<TResponse, TContext>(params: MlDeleteFilter, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteFilter
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_forecast:function
    • delete_forecast<TResponse, TContext>(params?: MlDeleteForecast, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_forecast<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_forecast<TResponse, TContext>(params: MlDeleteForecast, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_forecast<TResponse, TContext>(params: MlDeleteForecast, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteForecast
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_job:function
    • delete_job<TResponse, TContext>(params?: MlDeleteJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlDeleteJob
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_job<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_job<TResponse, TContext>(params: MlDeleteJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteJob
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_job<TResponse, TContext>(params: MlDeleteJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_model_snapshot:function
    • delete_model_snapshot<TResponse, TContext>(params?: MlDeleteModelSnapshot, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_model_snapshot<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_model_snapshot<TResponse, TContext>(params: MlDeleteModelSnapshot, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_model_snapshot<TResponse, TContext>(params: MlDeleteModelSnapshot, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteModelSnapshot
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_trained_model:function
    • delete_trained_model<TResponse, TContext>(params?: MlDeleteTrainedModel, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_trained_model<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_trained_model<TResponse, TContext>(params: MlDeleteTrainedModel, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_trained_model<TResponse, TContext>(params: MlDeleteTrainedModel, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlDeleteTrainedModel
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • estimateModelMemory:function
    • estimateModelMemory<TResponse, TRequestBody, TContext>(params?: MlEstimateModelMemory<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • estimateModelMemory<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • estimateModelMemory<TResponse, TRequestBody, TContext>(params: MlEstimateModelMemory<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • estimateModelMemory<TResponse, TRequestBody, TContext>(params: MlEstimateModelMemory<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlEstimateModelMemory<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • estimate_model_memory:function
    • estimate_model_memory<TResponse, TRequestBody, TContext>(params?: MlEstimateModelMemory<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • estimate_model_memory<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • estimate_model_memory<TResponse, TRequestBody, TContext>(params: MlEstimateModelMemory<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • estimate_model_memory<TResponse, TRequestBody, TContext>(params: MlEstimateModelMemory<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlEstimateModelMemory<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • evaluateDataFrame:function
    • evaluateDataFrame<TResponse, TRequestBody, TContext>(params?: MlEvaluateDataFrame<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • evaluateDataFrame<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • evaluateDataFrame<TResponse, TRequestBody, TContext>(params: MlEvaluateDataFrame<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • evaluateDataFrame<TResponse, TRequestBody, TContext>(params: MlEvaluateDataFrame<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlEvaluateDataFrame<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • evaluate_data_frame:function
    • evaluate_data_frame<TResponse, TRequestBody, TContext>(params?: MlEvaluateDataFrame<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • evaluate_data_frame<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • evaluate_data_frame<TResponse, TRequestBody, TContext>(params: MlEvaluateDataFrame<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • evaluate_data_frame<TResponse, TRequestBody, TContext>(params: MlEvaluateDataFrame<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlEvaluateDataFrame<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • explainDataFrameAnalytics:function
    • explainDataFrameAnalytics<TResponse, TRequestBody, TContext>(params?: MlExplainDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • explainDataFrameAnalytics<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • explainDataFrameAnalytics<TResponse, TRequestBody, TContext>(params: MlExplainDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • explainDataFrameAnalytics<TResponse, TRequestBody, TContext>(params: MlExplainDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • explain_data_frame_analytics:function
    • explain_data_frame_analytics<TResponse, TRequestBody, TContext>(params?: MlExplainDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • explain_data_frame_analytics<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • explain_data_frame_analytics<TResponse, TRequestBody, TContext>(params: MlExplainDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • explain_data_frame_analytics<TResponse, TRequestBody, TContext>(params: MlExplainDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • flushJob:function
    • flushJob<TResponse, TRequestBody, TContext>(params?: MlFlushJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlFlushJob<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • flushJob<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • flushJob<TResponse, TRequestBody, TContext>(params: MlFlushJob<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlFlushJob<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • flushJob<TResponse, TRequestBody, TContext>(params: MlFlushJob<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlFlushJob<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • flush_job:function
    • flush_job<TResponse, TRequestBody, TContext>(params?: MlFlushJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlFlushJob<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • flush_job<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • flush_job<TResponse, TRequestBody, TContext>(params: MlFlushJob<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlFlushJob<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • flush_job<TResponse, TRequestBody, TContext>(params: MlFlushJob<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlFlushJob<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • forecast:function
    • forecast<TResponse, TContext>(params?: MlForecast, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlForecast
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • forecast<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • forecast<TResponse, TContext>(params: MlForecast, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlForecast
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • forecast<TResponse, TContext>(params: MlForecast, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlForecast
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getBuckets:function
    • getBuckets<TResponse, TRequestBody, TContext>(params?: MlGetBuckets<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetBuckets<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getBuckets<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getBuckets<TResponse, TRequestBody, TContext>(params: MlGetBuckets<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetBuckets<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getBuckets<TResponse, TRequestBody, TContext>(params: MlGetBuckets<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetBuckets<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getCalendarEvents:function
    • getCalendarEvents<TResponse, TContext>(params?: MlGetCalendarEvents, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getCalendarEvents<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getCalendarEvents<TResponse, TContext>(params: MlGetCalendarEvents, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getCalendarEvents<TResponse, TContext>(params: MlGetCalendarEvents, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetCalendarEvents
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getCalendars:function
    • getCalendars<TResponse, TRequestBody, TContext>(params?: MlGetCalendars<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetCalendars<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getCalendars<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getCalendars<TResponse, TRequestBody, TContext>(params: MlGetCalendars<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetCalendars<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getCalendars<TResponse, TRequestBody, TContext>(params: MlGetCalendars<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetCalendars<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getCategories:function
    • getCategories<TResponse, TRequestBody, TContext>(params?: MlGetCategories<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetCategories<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getCategories<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getCategories<TResponse, TRequestBody, TContext>(params: MlGetCategories<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetCategories<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getCategories<TResponse, TRequestBody, TContext>(params: MlGetCategories<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetCategories<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getDataFrameAnalytics:function
    • getDataFrameAnalytics<TResponse, TContext>(params?: MlGetDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getDataFrameAnalytics<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getDataFrameAnalytics<TResponse, TContext>(params: MlGetDataFrameAnalytics, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getDataFrameAnalytics<TResponse, TContext>(params: MlGetDataFrameAnalytics, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getDataFrameAnalyticsStats:function
    • getDataFrameAnalyticsStats<TResponse, TContext>(params?: MlGetDataFrameAnalyticsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getDataFrameAnalyticsStats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getDataFrameAnalyticsStats<TResponse, TContext>(params: MlGetDataFrameAnalyticsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getDataFrameAnalyticsStats<TResponse, TContext>(params: MlGetDataFrameAnalyticsStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getDatafeedStats:function
    • getDatafeedStats<TResponse, TContext>(params?: MlGetDatafeedStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getDatafeedStats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getDatafeedStats<TResponse, TContext>(params: MlGetDatafeedStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getDatafeedStats<TResponse, TContext>(params: MlGetDatafeedStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetDatafeedStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getDatafeeds:function
    • getDatafeeds<TResponse, TContext>(params?: MlGetDatafeeds, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetDatafeeds
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getDatafeeds<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getDatafeeds<TResponse, TContext>(params: MlGetDatafeeds, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getDatafeeds<TResponse, TContext>(params: MlGetDatafeeds, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetDatafeeds
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getFilters:function
    • getFilters<TResponse, TContext>(params?: MlGetFilters, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetFilters
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getFilters<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getFilters<TResponse, TContext>(params: MlGetFilters, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetFilters
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getFilters<TResponse, TContext>(params: MlGetFilters, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetFilters
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getInfluencers:function
    • getInfluencers<TResponse, TRequestBody, TContext>(params?: MlGetInfluencers<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetInfluencers<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getInfluencers<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getInfluencers<TResponse, TRequestBody, TContext>(params: MlGetInfluencers<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetInfluencers<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getInfluencers<TResponse, TRequestBody, TContext>(params: MlGetInfluencers<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetInfluencers<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getJobStats:function
    • getJobStats<TResponse, TContext>(params?: MlGetJobStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetJobStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getJobStats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getJobStats<TResponse, TContext>(params: MlGetJobStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getJobStats<TResponse, TContext>(params: MlGetJobStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetJobStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getJobs:function
    • getJobs<TResponse, TContext>(params?: MlGetJobs, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetJobs
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getJobs<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getJobs<TResponse, TContext>(params: MlGetJobs, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetJobs
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getJobs<TResponse, TContext>(params: MlGetJobs, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetJobs
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getModelSnapshots:function
    • getModelSnapshots<TResponse, TRequestBody, TContext>(params?: MlGetModelSnapshots<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getModelSnapshots<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getModelSnapshots<TResponse, TRequestBody, TContext>(params: MlGetModelSnapshots<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getModelSnapshots<TResponse, TRequestBody, TContext>(params: MlGetModelSnapshots<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetModelSnapshots<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getOverallBuckets:function
    • getOverallBuckets<TResponse, TRequestBody, TContext>(params?: MlGetOverallBuckets<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getOverallBuckets<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getOverallBuckets<TResponse, TRequestBody, TContext>(params: MlGetOverallBuckets<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getOverallBuckets<TResponse, TRequestBody, TContext>(params: MlGetOverallBuckets<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetOverallBuckets<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getRecords:function
    • getRecords<TResponse, TRequestBody, TContext>(params?: MlGetRecords<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetRecords<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getRecords<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getRecords<TResponse, TRequestBody, TContext>(params: MlGetRecords<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetRecords<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getRecords<TResponse, TRequestBody, TContext>(params: MlGetRecords<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetRecords<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getTrainedModels:function
    • getTrainedModels<TResponse, TContext>(params?: MlGetTrainedModels, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getTrainedModels<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getTrainedModels<TResponse, TContext>(params: MlGetTrainedModels, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getTrainedModels<TResponse, TContext>(params: MlGetTrainedModels, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetTrainedModels
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getTrainedModelsStats:function
    • getTrainedModelsStats<TResponse, TContext>(params?: MlGetTrainedModelsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getTrainedModelsStats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getTrainedModelsStats<TResponse, TContext>(params: MlGetTrainedModelsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getTrainedModelsStats<TResponse, TContext>(params: MlGetTrainedModelsStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_buckets:function
    • get_buckets<TResponse, TRequestBody, TContext>(params?: MlGetBuckets<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetBuckets<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_buckets<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_buckets<TResponse, TRequestBody, TContext>(params: MlGetBuckets<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetBuckets<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_buckets<TResponse, TRequestBody, TContext>(params: MlGetBuckets<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetBuckets<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_calendar_events:function
    • get_calendar_events<TResponse, TContext>(params?: MlGetCalendarEvents, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_calendar_events<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_calendar_events<TResponse, TContext>(params: MlGetCalendarEvents, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_calendar_events<TResponse, TContext>(params: MlGetCalendarEvents, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetCalendarEvents
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_calendars:function
    • get_calendars<TResponse, TRequestBody, TContext>(params?: MlGetCalendars<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetCalendars<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_calendars<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_calendars<TResponse, TRequestBody, TContext>(params: MlGetCalendars<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetCalendars<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_calendars<TResponse, TRequestBody, TContext>(params: MlGetCalendars<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetCalendars<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_categories:function
    • get_categories<TResponse, TRequestBody, TContext>(params?: MlGetCategories<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetCategories<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_categories<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_categories<TResponse, TRequestBody, TContext>(params: MlGetCategories<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetCategories<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_categories<TResponse, TRequestBody, TContext>(params: MlGetCategories<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetCategories<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_data_frame_analytics:function
    • get_data_frame_analytics<TResponse, TContext>(params?: MlGetDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_data_frame_analytics<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_data_frame_analytics<TResponse, TContext>(params: MlGetDataFrameAnalytics, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_data_frame_analytics<TResponse, TContext>(params: MlGetDataFrameAnalytics, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_data_frame_analytics_stats:function
    • get_data_frame_analytics_stats<TResponse, TContext>(params?: MlGetDataFrameAnalyticsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_data_frame_analytics_stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_data_frame_analytics_stats<TResponse, TContext>(params: MlGetDataFrameAnalyticsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_data_frame_analytics_stats<TResponse, TContext>(params: MlGetDataFrameAnalyticsStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_datafeed_stats:function
    • get_datafeed_stats<TResponse, TContext>(params?: MlGetDatafeedStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_datafeed_stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_datafeed_stats<TResponse, TContext>(params: MlGetDatafeedStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_datafeed_stats<TResponse, TContext>(params: MlGetDatafeedStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetDatafeedStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_datafeeds:function
    • get_datafeeds<TResponse, TContext>(params?: MlGetDatafeeds, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetDatafeeds
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_datafeeds<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_datafeeds<TResponse, TContext>(params: MlGetDatafeeds, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_datafeeds<TResponse, TContext>(params: MlGetDatafeeds, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetDatafeeds
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_filters:function
    • get_filters<TResponse, TContext>(params?: MlGetFilters, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetFilters
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_filters<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_filters<TResponse, TContext>(params: MlGetFilters, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetFilters
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_filters<TResponse, TContext>(params: MlGetFilters, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetFilters
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_influencers:function
    • get_influencers<TResponse, TRequestBody, TContext>(params?: MlGetInfluencers<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetInfluencers<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_influencers<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_influencers<TResponse, TRequestBody, TContext>(params: MlGetInfluencers<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetInfluencers<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_influencers<TResponse, TRequestBody, TContext>(params: MlGetInfluencers<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetInfluencers<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_job_stats:function
    • get_job_stats<TResponse, TContext>(params?: MlGetJobStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetJobStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_job_stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_job_stats<TResponse, TContext>(params: MlGetJobStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_job_stats<TResponse, TContext>(params: MlGetJobStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetJobStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_jobs:function
    • get_jobs<TResponse, TContext>(params?: MlGetJobs, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetJobs
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_jobs<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_jobs<TResponse, TContext>(params: MlGetJobs, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetJobs
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_jobs<TResponse, TContext>(params: MlGetJobs, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetJobs
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_model_snapshots:function
    • get_model_snapshots<TResponse, TRequestBody, TContext>(params?: MlGetModelSnapshots<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_model_snapshots<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_model_snapshots<TResponse, TRequestBody, TContext>(params: MlGetModelSnapshots<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_model_snapshots<TResponse, TRequestBody, TContext>(params: MlGetModelSnapshots<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetModelSnapshots<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_overall_buckets:function
    • get_overall_buckets<TResponse, TRequestBody, TContext>(params?: MlGetOverallBuckets<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_overall_buckets<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_overall_buckets<TResponse, TRequestBody, TContext>(params: MlGetOverallBuckets<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_overall_buckets<TResponse, TRequestBody, TContext>(params: MlGetOverallBuckets<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetOverallBuckets<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_records:function
    • get_records<TResponse, TRequestBody, TContext>(params?: MlGetRecords<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlGetRecords<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_records<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_records<TResponse, TRequestBody, TContext>(params: MlGetRecords<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetRecords<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_records<TResponse, TRequestBody, TContext>(params: MlGetRecords<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetRecords<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_trained_models:function
    • get_trained_models<TResponse, TContext>(params?: MlGetTrainedModels, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_trained_models<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_trained_models<TResponse, TContext>(params: MlGetTrainedModels, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_trained_models<TResponse, TContext>(params: MlGetTrainedModels, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlGetTrainedModels
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_trained_models_stats:function
    • get_trained_models_stats<TResponse, TContext>(params?: MlGetTrainedModelsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_trained_models_stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_trained_models_stats<TResponse, TContext>(params: MlGetTrainedModelsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_trained_models_stats<TResponse, TContext>(params: MlGetTrainedModelsStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • info:function
    • info<TResponse, TContext>(params?: MlInfo, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlInfo
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • info<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • info<TResponse, TContext>(params: MlInfo, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlInfo
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • info<TResponse, TContext>(params: MlInfo, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlInfo
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • openJob:function
    • openJob<TResponse, TContext>(params?: MlOpenJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlOpenJob
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • openJob<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • openJob<TResponse, TContext>(params: MlOpenJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlOpenJob
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • openJob<TResponse, TContext>(params: MlOpenJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlOpenJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • open_job:function
    • open_job<TResponse, TContext>(params?: MlOpenJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlOpenJob
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • open_job<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • open_job<TResponse, TContext>(params: MlOpenJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlOpenJob
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • open_job<TResponse, TContext>(params: MlOpenJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlOpenJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • postCalendarEvents:function
    • postCalendarEvents<TResponse, TRequestBody, TContext>(params?: MlPostCalendarEvents<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • postCalendarEvents<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • postCalendarEvents<TResponse, TRequestBody, TContext>(params: MlPostCalendarEvents<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • postCalendarEvents<TResponse, TRequestBody, TContext>(params: MlPostCalendarEvents<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPostCalendarEvents<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • postData:function
    • postData<TResponse, TRequestBody, TContext>(params?: MlPostData<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPostData<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • postData<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • postData<TResponse, TRequestBody, TContext>(params: MlPostData<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPostData<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • postData<TResponse, TRequestBody, TContext>(params: MlPostData<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPostData<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • post_calendar_events:function
    • post_calendar_events<TResponse, TRequestBody, TContext>(params?: MlPostCalendarEvents<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • post_calendar_events<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • post_calendar_events<TResponse, TRequestBody, TContext>(params: MlPostCalendarEvents<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • post_calendar_events<TResponse, TRequestBody, TContext>(params: MlPostCalendarEvents<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPostCalendarEvents<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • post_data:function
    • post_data<TResponse, TRequestBody, TContext>(params?: MlPostData<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPostData<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • post_data<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • post_data<TResponse, TRequestBody, TContext>(params: MlPostData<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPostData<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • post_data<TResponse, TRequestBody, TContext>(params: MlPostData<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPostData<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • previewDatafeed:function
    • previewDatafeed<TResponse, TContext>(params?: MlPreviewDatafeed, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • previewDatafeed<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • previewDatafeed<TResponse, TContext>(params: MlPreviewDatafeed, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • previewDatafeed<TResponse, TContext>(params: MlPreviewDatafeed, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPreviewDatafeed
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • preview_datafeed:function
    • preview_datafeed<TResponse, TContext>(params?: MlPreviewDatafeed, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • preview_datafeed<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • preview_datafeed<TResponse, TContext>(params: MlPreviewDatafeed, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • preview_datafeed<TResponse, TContext>(params: MlPreviewDatafeed, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPreviewDatafeed
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putCalendar:function
    • putCalendar<TResponse, TRequestBody, TContext>(params?: MlPutCalendar<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPutCalendar<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putCalendar<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putCalendar<TResponse, TRequestBody, TContext>(params: MlPutCalendar<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutCalendar<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putCalendar<TResponse, TRequestBody, TContext>(params: MlPutCalendar<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutCalendar<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putCalendarJob:function
    • putCalendarJob<TResponse, TContext>(params?: MlPutCalendarJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putCalendarJob<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putCalendarJob<TResponse, TContext>(params: MlPutCalendarJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putCalendarJob<TResponse, TContext>(params: MlPutCalendarJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutCalendarJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putDataFrameAnalytics:function
    • putDataFrameAnalytics<TResponse, TRequestBody, TContext>(params?: MlPutDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putDataFrameAnalytics<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putDataFrameAnalytics<TResponse, TRequestBody, TContext>(params: MlPutDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putDataFrameAnalytics<TResponse, TRequestBody, TContext>(params: MlPutDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutDataFrameAnalytics<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putDatafeed:function
    • putDatafeed<TResponse, TRequestBody, TContext>(params?: MlPutDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPutDatafeed<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putDatafeed<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putDatafeed<TResponse, TRequestBody, TContext>(params: MlPutDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutDatafeed<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putDatafeed<TResponse, TRequestBody, TContext>(params: MlPutDatafeed<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutDatafeed<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putFilter:function
    • putFilter<TResponse, TRequestBody, TContext>(params?: MlPutFilter<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPutFilter<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putFilter<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putFilter<TResponse, TRequestBody, TContext>(params: MlPutFilter<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutFilter<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putFilter<TResponse, TRequestBody, TContext>(params: MlPutFilter<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutFilter<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putJob:function
    • putJob<TResponse, TRequestBody, TContext>(params?: MlPutJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPutJob<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putJob<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putJob<TResponse, TRequestBody, TContext>(params: MlPutJob<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutJob<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putJob<TResponse, TRequestBody, TContext>(params: MlPutJob<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutJob<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putTrainedModel:function
    • putTrainedModel<TResponse, TRequestBody, TContext>(params?: MlPutTrainedModel<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPutTrainedModel<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putTrainedModel<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putTrainedModel<TResponse, TRequestBody, TContext>(params: MlPutTrainedModel<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putTrainedModel<TResponse, TRequestBody, TContext>(params: MlPutTrainedModel<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutTrainedModel<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_calendar:function
    • put_calendar<TResponse, TRequestBody, TContext>(params?: MlPutCalendar<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPutCalendar<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_calendar<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_calendar<TResponse, TRequestBody, TContext>(params: MlPutCalendar<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutCalendar<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_calendar<TResponse, TRequestBody, TContext>(params: MlPutCalendar<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutCalendar<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_calendar_job:function
    • put_calendar_job<TResponse, TContext>(params?: MlPutCalendarJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_calendar_job<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_calendar_job<TResponse, TContext>(params: MlPutCalendarJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_calendar_job<TResponse, TContext>(params: MlPutCalendarJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutCalendarJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_data_frame_analytics:function
    • put_data_frame_analytics<TResponse, TRequestBody, TContext>(params?: MlPutDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_data_frame_analytics<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_data_frame_analytics<TResponse, TRequestBody, TContext>(params: MlPutDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_data_frame_analytics<TResponse, TRequestBody, TContext>(params: MlPutDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutDataFrameAnalytics<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_datafeed:function
    • put_datafeed<TResponse, TRequestBody, TContext>(params?: MlPutDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPutDatafeed<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_datafeed<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_datafeed<TResponse, TRequestBody, TContext>(params: MlPutDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutDatafeed<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_datafeed<TResponse, TRequestBody, TContext>(params: MlPutDatafeed<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutDatafeed<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_filter:function
    • put_filter<TResponse, TRequestBody, TContext>(params?: MlPutFilter<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPutFilter<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_filter<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_filter<TResponse, TRequestBody, TContext>(params: MlPutFilter<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutFilter<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_filter<TResponse, TRequestBody, TContext>(params: MlPutFilter<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutFilter<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_job:function
    • put_job<TResponse, TRequestBody, TContext>(params?: MlPutJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPutJob<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_job<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_job<TResponse, TRequestBody, TContext>(params: MlPutJob<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutJob<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_job<TResponse, TRequestBody, TContext>(params: MlPutJob<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutJob<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_trained_model:function
    • put_trained_model<TResponse, TRequestBody, TContext>(params?: MlPutTrainedModel<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlPutTrainedModel<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_trained_model<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_trained_model<TResponse, TRequestBody, TContext>(params: MlPutTrainedModel<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_trained_model<TResponse, TRequestBody, TContext>(params: MlPutTrainedModel<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlPutTrainedModel<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • revertModelSnapshot:function
    • revertModelSnapshot<TResponse, TRequestBody, TContext>(params?: MlRevertModelSnapshot<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • revertModelSnapshot<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • revertModelSnapshot<TResponse, TRequestBody, TContext>(params: MlRevertModelSnapshot<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • revertModelSnapshot<TResponse, TRequestBody, TContext>(params: MlRevertModelSnapshot<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlRevertModelSnapshot<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • revert_model_snapshot:function
    • revert_model_snapshot<TResponse, TRequestBody, TContext>(params?: MlRevertModelSnapshot<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • revert_model_snapshot<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • revert_model_snapshot<TResponse, TRequestBody, TContext>(params: MlRevertModelSnapshot<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • revert_model_snapshot<TResponse, TRequestBody, TContext>(params: MlRevertModelSnapshot<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlRevertModelSnapshot<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • setUpgradeMode:function
    • setUpgradeMode<TResponse, TContext>(params?: MlSetUpgradeMode, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • setUpgradeMode<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • setUpgradeMode<TResponse, TContext>(params: MlSetUpgradeMode, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • setUpgradeMode<TResponse, TContext>(params: MlSetUpgradeMode, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlSetUpgradeMode
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • set_upgrade_mode:function
    • set_upgrade_mode<TResponse, TContext>(params?: MlSetUpgradeMode, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • set_upgrade_mode<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • set_upgrade_mode<TResponse, TContext>(params: MlSetUpgradeMode, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • set_upgrade_mode<TResponse, TContext>(params: MlSetUpgradeMode, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlSetUpgradeMode
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • startDataFrameAnalytics:function
    • startDataFrameAnalytics<TResponse, TRequestBody, TContext>(params?: MlStartDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • startDataFrameAnalytics<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • startDataFrameAnalytics<TResponse, TRequestBody, TContext>(params: MlStartDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • startDataFrameAnalytics<TResponse, TRequestBody, TContext>(params: MlStartDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • startDatafeed:function
    • startDatafeed<TResponse, TRequestBody, TContext>(params?: MlStartDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlStartDatafeed<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • startDatafeed<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • startDatafeed<TResponse, TRequestBody, TContext>(params: MlStartDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlStartDatafeed<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • startDatafeed<TResponse, TRequestBody, TContext>(params: MlStartDatafeed<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlStartDatafeed<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • start_data_frame_analytics:function
    • start_data_frame_analytics<TResponse, TRequestBody, TContext>(params?: MlStartDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • start_data_frame_analytics<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start_data_frame_analytics<TResponse, TRequestBody, TContext>(params: MlStartDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • start_data_frame_analytics<TResponse, TRequestBody, TContext>(params: MlStartDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • start_datafeed:function
    • start_datafeed<TResponse, TRequestBody, TContext>(params?: MlStartDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlStartDatafeed<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • start_datafeed<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start_datafeed<TResponse, TRequestBody, TContext>(params: MlStartDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlStartDatafeed<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start_datafeed<TResponse, TRequestBody, TContext>(params: MlStartDatafeed<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlStartDatafeed<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stopDataFrameAnalytics:function
    • stopDataFrameAnalytics<TResponse, TRequestBody, TContext>(params?: MlStopDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stopDataFrameAnalytics<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stopDataFrameAnalytics<TResponse, TRequestBody, TContext>(params: MlStopDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • stopDataFrameAnalytics<TResponse, TRequestBody, TContext>(params: MlStopDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlStopDataFrameAnalytics<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stopDatafeed:function
    • stopDatafeed<TResponse, TRequestBody, TContext>(params?: MlStopDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlStopDatafeed<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stopDatafeed<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stopDatafeed<TResponse, TRequestBody, TContext>(params: MlStopDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlStopDatafeed<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stopDatafeed<TResponse, TRequestBody, TContext>(params: MlStopDatafeed<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlStopDatafeed<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stop_data_frame_analytics:function
    • stop_data_frame_analytics<TResponse, TRequestBody, TContext>(params?: MlStopDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stop_data_frame_analytics<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop_data_frame_analytics<TResponse, TRequestBody, TContext>(params: MlStopDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • stop_data_frame_analytics<TResponse, TRequestBody, TContext>(params: MlStopDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlStopDataFrameAnalytics<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stop_datafeed:function
    • stop_datafeed<TResponse, TRequestBody, TContext>(params?: MlStopDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlStopDatafeed<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stop_datafeed<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop_datafeed<TResponse, TRequestBody, TContext>(params: MlStopDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlStopDatafeed<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop_datafeed<TResponse, TRequestBody, TContext>(params: MlStopDatafeed<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlStopDatafeed<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • updateDataFrameAnalytics:function
    • updateDataFrameAnalytics<TResponse, TRequestBody, TContext>(params?: MlUpdateDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • updateDataFrameAnalytics<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • updateDataFrameAnalytics<TResponse, TRequestBody, TContext>(params: MlUpdateDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • updateDataFrameAnalytics<TResponse, TRequestBody, TContext>(params: MlUpdateDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • updateDatafeed:function
    • updateDatafeed<TResponse, TRequestBody, TContext>(params?: MlUpdateDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlUpdateDatafeed<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • updateDatafeed<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • updateDatafeed<TResponse, TRequestBody, TContext>(params: MlUpdateDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateDatafeed<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • updateDatafeed<TResponse, TRequestBody, TContext>(params: MlUpdateDatafeed<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateDatafeed<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • updateFilter:function
    • updateFilter<TResponse, TRequestBody, TContext>(params?: MlUpdateFilter<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlUpdateFilter<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • updateFilter<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • updateFilter<TResponse, TRequestBody, TContext>(params: MlUpdateFilter<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateFilter<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • updateFilter<TResponse, TRequestBody, TContext>(params: MlUpdateFilter<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateFilter<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • updateJob:function
    • updateJob<TResponse, TRequestBody, TContext>(params?: MlUpdateJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlUpdateJob<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • updateJob<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • updateJob<TResponse, TRequestBody, TContext>(params: MlUpdateJob<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateJob<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • updateJob<TResponse, TRequestBody, TContext>(params: MlUpdateJob<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateJob<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • updateModelSnapshot:function
    • updateModelSnapshot<TResponse, TRequestBody, TContext>(params?: MlUpdateModelSnapshot<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • updateModelSnapshot<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • updateModelSnapshot<TResponse, TRequestBody, TContext>(params: MlUpdateModelSnapshot<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • updateModelSnapshot<TResponse, TRequestBody, TContext>(params: MlUpdateModelSnapshot<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateModelSnapshot<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • update_data_frame_analytics:function
    • update_data_frame_analytics<TResponse, TRequestBody, TContext>(params?: MlUpdateDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • update_data_frame_analytics<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • update_data_frame_analytics<TResponse, TRequestBody, TContext>(params: MlUpdateDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • update_data_frame_analytics<TResponse, TRequestBody, TContext>(params: MlUpdateDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • update_datafeed:function
    • update_datafeed<TResponse, TRequestBody, TContext>(params?: MlUpdateDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlUpdateDatafeed<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • update_datafeed<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • update_datafeed<TResponse, TRequestBody, TContext>(params: MlUpdateDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateDatafeed<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • update_datafeed<TResponse, TRequestBody, TContext>(params: MlUpdateDatafeed<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateDatafeed<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • update_filter:function
    • update_filter<TResponse, TRequestBody, TContext>(params?: MlUpdateFilter<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlUpdateFilter<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • update_filter<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • update_filter<TResponse, TRequestBody, TContext>(params: MlUpdateFilter<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateFilter<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • update_filter<TResponse, TRequestBody, TContext>(params: MlUpdateFilter<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateFilter<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • update_job:function
    • update_job<TResponse, TRequestBody, TContext>(params?: MlUpdateJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlUpdateJob<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • update_job<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • update_job<TResponse, TRequestBody, TContext>(params: MlUpdateJob<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateJob<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • update_job<TResponse, TRequestBody, TContext>(params: MlUpdateJob<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateJob<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • update_model_snapshot:function
    • update_model_snapshot<TResponse, TRequestBody, TContext>(params?: MlUpdateModelSnapshot<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • update_model_snapshot<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • update_model_snapshot<TResponse, TRequestBody, TContext>(params: MlUpdateModelSnapshot<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • update_model_snapshot<TResponse, TRequestBody, TContext>(params: MlUpdateModelSnapshot<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpdateModelSnapshot<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • upgradeJobSnapshot:function
    • upgradeJobSnapshot<TResponse, TContext>(params?: MlUpgradeJobSnapshot, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • upgradeJobSnapshot<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • upgradeJobSnapshot<TResponse, TContext>(params: MlUpgradeJobSnapshot, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • upgradeJobSnapshot<TResponse, TContext>(params: MlUpgradeJobSnapshot, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpgradeJobSnapshot
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • upgrade_job_snapshot:function
    • upgrade_job_snapshot<TResponse, TContext>(params?: MlUpgradeJobSnapshot, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • upgrade_job_snapshot<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • upgrade_job_snapshot<TResponse, TContext>(params: MlUpgradeJobSnapshot, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • upgrade_job_snapshot<TResponse, TContext>(params: MlUpgradeJobSnapshot, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlUpgradeJobSnapshot
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • validate:function
    • validate<TResponse, TRequestBody, TContext>(params?: MlValidate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlValidate<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • validate<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • validate<TResponse, TRequestBody, TContext>(params: MlValidate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlValidate<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • validate<TResponse, TRequestBody, TContext>(params: MlValidate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlValidate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • validateDetector:function
    • validateDetector<TResponse, TRequestBody, TContext>(params?: MlValidateDetector<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlValidateDetector<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • validateDetector<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • validateDetector<TResponse, TRequestBody, TContext>(params: MlValidateDetector<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • validateDetector<TResponse, TRequestBody, TContext>(params: MlValidateDetector<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlValidateDetector<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • validate_detector:function
    • validate_detector<TResponse, TRequestBody, TContext>(params?: MlValidateDetector<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MlValidateDetector<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • validate_detector<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • validate_detector<TResponse, TRequestBody, TContext>(params: MlValidateDetector<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • validate_detector<TResponse, TRequestBody, TContext>(params: MlValidateDetector<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: MlValidateDetector<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

monitoring

monitoring: { bulk: any }

Type declaration

  • bulk:function
    • bulk<TResponse, TRequestBody, TContext>(params?: MonitoringBulk<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: MonitoringBulk<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • bulk<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • bulk<TResponse, TRequestBody, TContext>(params: MonitoringBulk<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

      • TContext = Record<string, unknown>

      Parameters

      • params: MonitoringBulk<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • bulk<TResponse, TRequestBody, TContext>(params: MonitoringBulk<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

      • TContext = Record<string, unknown>

      Parameters

      • params: MonitoringBulk<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

nodes

nodes: { hotThreads: any; hot_threads: any; info: any; reloadSecureSettings: any; reload_secure_settings: any; stats: any; usage: any }

Type declaration

  • hotThreads:function
    • hotThreads<TResponse, TContext>(params?: NodesHotThreads, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: NodesHotThreads
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • hotThreads<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • hotThreads<TResponse, TContext>(params: NodesHotThreads, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • hotThreads<TResponse, TContext>(params: NodesHotThreads, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: NodesHotThreads
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • hot_threads:function
    • hot_threads<TResponse, TContext>(params?: NodesHotThreads, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: NodesHotThreads
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • hot_threads<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • hot_threads<TResponse, TContext>(params: NodesHotThreads, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • hot_threads<TResponse, TContext>(params: NodesHotThreads, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: NodesHotThreads
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • info:function
    • info<TResponse, TContext>(params?: NodesInfo, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: NodesInfo
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • info<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • info<TResponse, TContext>(params: NodesInfo, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: NodesInfo
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • info<TResponse, TContext>(params: NodesInfo, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: NodesInfo
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • reloadSecureSettings:function
    • reloadSecureSettings<TResponse, TRequestBody, TContext>(params?: NodesReloadSecureSettings<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • reloadSecureSettings<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • reloadSecureSettings<TResponse, TRequestBody, TContext>(params: NodesReloadSecureSettings<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • reloadSecureSettings<TResponse, TRequestBody, TContext>(params: NodesReloadSecureSettings<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • reload_secure_settings:function
    • reload_secure_settings<TResponse, TRequestBody, TContext>(params?: NodesReloadSecureSettings<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • reload_secure_settings<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • reload_secure_settings<TResponse, TRequestBody, TContext>(params: NodesReloadSecureSettings<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • reload_secure_settings<TResponse, TRequestBody, TContext>(params: NodesReloadSecureSettings<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • stats:function
    • stats<TResponse, TContext>(params?: NodesStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: NodesStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: NodesStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: NodesStats
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: NodesStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: NodesStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • usage:function
    • usage<TResponse, TContext>(params?: NodesUsage, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: NodesUsage
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • usage<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • usage<TResponse, TContext>(params: NodesUsage, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: NodesUsage
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • usage<TResponse, TContext>(params: NodesUsage, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: NodesUsage
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

rollup

rollup: { deleteJob: any; delete_job: any; getJobs: any; getRollupCaps: any; getRollupIndexCaps: any; get_jobs: any; get_rollup_caps: any; get_rollup_index_caps: any; putJob: any; put_job: any; rollup: any; rollupSearch: any; rollup_search: any; startJob: any; start_job: any; stopJob: any; stop_job: any }

Type declaration

  • deleteJob:function
    • deleteJob<TResponse, TContext>(params?: RollupDeleteJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupDeleteJob
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteJob<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteJob<TResponse, TContext>(params: RollupDeleteJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteJob<TResponse, TContext>(params: RollupDeleteJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupDeleteJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_job:function
    • delete_job<TResponse, TContext>(params?: RollupDeleteJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupDeleteJob
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_job<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_job<TResponse, TContext>(params: RollupDeleteJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_job<TResponse, TContext>(params: RollupDeleteJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupDeleteJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getJobs:function
    • getJobs<TResponse, TContext>(params?: RollupGetJobs, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupGetJobs
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getJobs<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getJobs<TResponse, TContext>(params: RollupGetJobs, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getJobs<TResponse, TContext>(params: RollupGetJobs, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupGetJobs
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getRollupCaps:function
    • getRollupCaps<TResponse, TContext>(params?: RollupGetRollupCaps, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getRollupCaps<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getRollupCaps<TResponse, TContext>(params: RollupGetRollupCaps, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getRollupCaps<TResponse, TContext>(params: RollupGetRollupCaps, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupGetRollupCaps
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getRollupIndexCaps:function
    • getRollupIndexCaps<TResponse, TContext>(params?: RollupGetRollupIndexCaps, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getRollupIndexCaps<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getRollupIndexCaps<TResponse, TContext>(params: RollupGetRollupIndexCaps, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getRollupIndexCaps<TResponse, TContext>(params: RollupGetRollupIndexCaps, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_jobs:function
    • get_jobs<TResponse, TContext>(params?: RollupGetJobs, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupGetJobs
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_jobs<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_jobs<TResponse, TContext>(params: RollupGetJobs, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_jobs<TResponse, TContext>(params: RollupGetJobs, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupGetJobs
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_rollup_caps:function
    • get_rollup_caps<TResponse, TContext>(params?: RollupGetRollupCaps, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_rollup_caps<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_rollup_caps<TResponse, TContext>(params: RollupGetRollupCaps, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_rollup_caps<TResponse, TContext>(params: RollupGetRollupCaps, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupGetRollupCaps
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_rollup_index_caps:function
    • get_rollup_index_caps<TResponse, TContext>(params?: RollupGetRollupIndexCaps, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_rollup_index_caps<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_rollup_index_caps<TResponse, TContext>(params: RollupGetRollupIndexCaps, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_rollup_index_caps<TResponse, TContext>(params: RollupGetRollupIndexCaps, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • putJob:function
    • putJob<TResponse, TRequestBody, TContext>(params?: RollupPutJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupPutJob<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putJob<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putJob<TResponse, TRequestBody, TContext>(params: RollupPutJob<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupPutJob<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putJob<TResponse, TRequestBody, TContext>(params: RollupPutJob<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupPutJob<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_job:function
    • put_job<TResponse, TRequestBody, TContext>(params?: RollupPutJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupPutJob<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_job<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_job<TResponse, TRequestBody, TContext>(params: RollupPutJob<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupPutJob<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_job<TResponse, TRequestBody, TContext>(params: RollupPutJob<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupPutJob<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • rollup:function
    • rollup<TResponse, TRequestBody, TContext>(params?: RollupRollup<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupRollup<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • rollup<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • rollup<TResponse, TRequestBody, TContext>(params: RollupRollup<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupRollup<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • rollup<TResponse, TRequestBody, TContext>(params: RollupRollup<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupRollup<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • rollupSearch:function
    • rollupSearch<TResponse, TRequestBody, TContext>(params?: RollupRollupSearch<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupRollupSearch<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • rollupSearch<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • rollupSearch<TResponse, TRequestBody, TContext>(params: RollupRollupSearch<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • rollupSearch<TResponse, TRequestBody, TContext>(params: RollupRollupSearch<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupRollupSearch<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • rollup_search:function
    • rollup_search<TResponse, TRequestBody, TContext>(params?: RollupRollupSearch<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupRollupSearch<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • rollup_search<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • rollup_search<TResponse, TRequestBody, TContext>(params: RollupRollupSearch<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • rollup_search<TResponse, TRequestBody, TContext>(params: RollupRollupSearch<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupRollupSearch<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • startJob:function
    • startJob<TResponse, TContext>(params?: RollupStartJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupStartJob
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • startJob<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • startJob<TResponse, TContext>(params: RollupStartJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • startJob<TResponse, TContext>(params: RollupStartJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupStartJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • start_job:function
    • start_job<TResponse, TContext>(params?: RollupStartJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupStartJob
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • start_job<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start_job<TResponse, TContext>(params: RollupStartJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • start_job<TResponse, TContext>(params: RollupStartJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupStartJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stopJob:function
    • stopJob<TResponse, TContext>(params?: RollupStopJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupStopJob
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stopJob<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stopJob<TResponse, TContext>(params: RollupStopJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • stopJob<TResponse, TContext>(params: RollupStopJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupStopJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stop_job:function
    • stop_job<TResponse, TContext>(params?: RollupStopJob, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: RollupStopJob
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stop_job<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop_job<TResponse, TContext>(params: RollupStopJob, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • stop_job<TResponse, TContext>(params: RollupStopJob, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: RollupStopJob
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

searchableSnapshots

searchableSnapshots: { clearCache: any; clear_cache: any; mount: any; repositoryStats: any; repository_stats: any; stats: any }

Type declaration

  • clearCache:function
    • clearCache<TResponse, TContext>(params?: SearchableSnapshotsClearCache, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clearCache<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clearCache<TResponse, TContext>(params: SearchableSnapshotsClearCache, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clearCache<TResponse, TContext>(params: SearchableSnapshotsClearCache, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • clear_cache:function
    • clear_cache<TResponse, TContext>(params?: SearchableSnapshotsClearCache, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clear_cache<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clear_cache<TResponse, TContext>(params: SearchableSnapshotsClearCache, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clear_cache<TResponse, TContext>(params: SearchableSnapshotsClearCache, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • mount:function
    • mount<TResponse, TRequestBody, TContext>(params?: SearchableSnapshotsMount<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • mount<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • mount<TResponse, TRequestBody, TContext>(params: SearchableSnapshotsMount<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • mount<TResponse, TRequestBody, TContext>(params: SearchableSnapshotsMount<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SearchableSnapshotsMount<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • repositoryStats:function
    • repositoryStats<TResponse, TContext>(params?: SearchableSnapshotsRepositoryStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • repositoryStats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • repositoryStats<TResponse, TContext>(params: SearchableSnapshotsRepositoryStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • repositoryStats<TResponse, TContext>(params: SearchableSnapshotsRepositoryStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • repository_stats:function
    • repository_stats<TResponse, TContext>(params?: SearchableSnapshotsRepositoryStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • repository_stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • repository_stats<TResponse, TContext>(params: SearchableSnapshotsRepositoryStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • repository_stats<TResponse, TContext>(params: SearchableSnapshotsRepositoryStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • stats:function
    • stats<TResponse, TContext>(params?: SearchableSnapshotsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: SearchableSnapshotsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: SearchableSnapshotsStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

searchable_snapshots

searchable_snapshots: { clearCache: any; clear_cache: any; mount: any; repositoryStats: any; repository_stats: any; stats: any }

Type declaration

  • clearCache:function
    • clearCache<TResponse, TContext>(params?: SearchableSnapshotsClearCache, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clearCache<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clearCache<TResponse, TContext>(params: SearchableSnapshotsClearCache, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clearCache<TResponse, TContext>(params: SearchableSnapshotsClearCache, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • clear_cache:function
    • clear_cache<TResponse, TContext>(params?: SearchableSnapshotsClearCache, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clear_cache<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clear_cache<TResponse, TContext>(params: SearchableSnapshotsClearCache, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clear_cache<TResponse, TContext>(params: SearchableSnapshotsClearCache, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • mount:function
    • mount<TResponse, TRequestBody, TContext>(params?: SearchableSnapshotsMount<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • mount<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • mount<TResponse, TRequestBody, TContext>(params: SearchableSnapshotsMount<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • mount<TResponse, TRequestBody, TContext>(params: SearchableSnapshotsMount<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SearchableSnapshotsMount<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • repositoryStats:function
    • repositoryStats<TResponse, TContext>(params?: SearchableSnapshotsRepositoryStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • repositoryStats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • repositoryStats<TResponse, TContext>(params: SearchableSnapshotsRepositoryStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • repositoryStats<TResponse, TContext>(params: SearchableSnapshotsRepositoryStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • repository_stats:function
    • repository_stats<TResponse, TContext>(params?: SearchableSnapshotsRepositoryStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • repository_stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • repository_stats<TResponse, TContext>(params: SearchableSnapshotsRepositoryStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • repository_stats<TResponse, TContext>(params: SearchableSnapshotsRepositoryStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • stats:function
    • stats<TResponse, TContext>(params?: SearchableSnapshotsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: SearchableSnapshotsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: SearchableSnapshotsStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

security

security: { authenticate: any; changePassword: any; change_password: any; clearApiKeyCache: any; clearCachedPrivileges: any; clearCachedRealms: any; clearCachedRoles: any; clear_api_key_cache: any; clear_cached_privileges: any; clear_cached_realms: any; clear_cached_roles: any; createApiKey: any; create_api_key: any; deletePrivileges: any; deleteRole: any; deleteRoleMapping: any; deleteUser: any; delete_privileges: any; delete_role: any; delete_role_mapping: any; delete_user: any; disableUser: any; disable_user: any; enableUser: any; enable_user: any; getApiKey: any; getBuiltinPrivileges: any; getPrivileges: any; getRole: any; getRoleMapping: any; getToken: any; getUser: any; getUserPrivileges: any; get_api_key: any; get_builtin_privileges: any; get_privileges: any; get_role: any; get_role_mapping: any; get_token: any; get_user: any; get_user_privileges: any; grantApiKey: any; grant_api_key: any; hasPrivileges: any; has_privileges: any; invalidateApiKey: any; invalidateToken: any; invalidate_api_key: any; invalidate_token: any; putPrivileges: any; putRole: any; putRoleMapping: any; putUser: any; put_privileges: any; put_role: any; put_role_mapping: any; put_user: any }

Type declaration

  • authenticate:function
    • authenticate<TResponse, TContext>(params?: SecurityAuthenticate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • authenticate<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • authenticate<TResponse, TContext>(params: SecurityAuthenticate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • authenticate<TResponse, TContext>(params: SecurityAuthenticate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityAuthenticate
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • changePassword:function
    • changePassword<TResponse, TRequestBody, TContext>(params?: SecurityChangePassword<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • changePassword<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • changePassword<TResponse, TRequestBody, TContext>(params: SecurityChangePassword<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • changePassword<TResponse, TRequestBody, TContext>(params: SecurityChangePassword<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityChangePassword<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • change_password:function
    • change_password<TResponse, TRequestBody, TContext>(params?: SecurityChangePassword<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • change_password<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • change_password<TResponse, TRequestBody, TContext>(params: SecurityChangePassword<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • change_password<TResponse, TRequestBody, TContext>(params: SecurityChangePassword<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityChangePassword<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • clearApiKeyCache:function
    • clearApiKeyCache<TResponse, TContext>(params?: SecurityClearApiKeyCache, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clearApiKeyCache<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clearApiKeyCache<TResponse, TContext>(params: SecurityClearApiKeyCache, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clearApiKeyCache<TResponse, TContext>(params: SecurityClearApiKeyCache, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • clearCachedPrivileges:function
    • clearCachedPrivileges<TResponse, TContext>(params?: SecurityClearCachedPrivileges, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clearCachedPrivileges<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clearCachedPrivileges<TResponse, TContext>(params: SecurityClearCachedPrivileges, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clearCachedPrivileges<TResponse, TContext>(params: SecurityClearCachedPrivileges, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • clearCachedRealms:function
    • clearCachedRealms<TResponse, TContext>(params?: SecurityClearCachedRealms, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clearCachedRealms<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clearCachedRealms<TResponse, TContext>(params: SecurityClearCachedRealms, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clearCachedRealms<TResponse, TContext>(params: SecurityClearCachedRealms, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • clearCachedRoles:function
    • clearCachedRoles<TResponse, TContext>(params?: SecurityClearCachedRoles, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clearCachedRoles<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clearCachedRoles<TResponse, TContext>(params: SecurityClearCachedRoles, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clearCachedRoles<TResponse, TContext>(params: SecurityClearCachedRoles, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • clear_api_key_cache:function
    • clear_api_key_cache<TResponse, TContext>(params?: SecurityClearApiKeyCache, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clear_api_key_cache<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clear_api_key_cache<TResponse, TContext>(params: SecurityClearApiKeyCache, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clear_api_key_cache<TResponse, TContext>(params: SecurityClearApiKeyCache, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • clear_cached_privileges:function
    • clear_cached_privileges<TResponse, TContext>(params?: SecurityClearCachedPrivileges, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clear_cached_privileges<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clear_cached_privileges<TResponse, TContext>(params: SecurityClearCachedPrivileges, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clear_cached_privileges<TResponse, TContext>(params: SecurityClearCachedPrivileges, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • clear_cached_realms:function
    • clear_cached_realms<TResponse, TContext>(params?: SecurityClearCachedRealms, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clear_cached_realms<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clear_cached_realms<TResponse, TContext>(params: SecurityClearCachedRealms, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clear_cached_realms<TResponse, TContext>(params: SecurityClearCachedRealms, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • clear_cached_roles:function
    • clear_cached_roles<TResponse, TContext>(params?: SecurityClearCachedRoles, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clear_cached_roles<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clear_cached_roles<TResponse, TContext>(params: SecurityClearCachedRoles, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • clear_cached_roles<TResponse, TContext>(params: SecurityClearCachedRoles, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • createApiKey:function
    • createApiKey<TResponse, TRequestBody, TContext>(params?: SecurityCreateApiKey<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • createApiKey<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • createApiKey<TResponse, TRequestBody, TContext>(params: SecurityCreateApiKey<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • createApiKey<TResponse, TRequestBody, TContext>(params: SecurityCreateApiKey<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityCreateApiKey<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • create_api_key:function
    • create_api_key<TResponse, TRequestBody, TContext>(params?: SecurityCreateApiKey<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • create_api_key<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • create_api_key<TResponse, TRequestBody, TContext>(params: SecurityCreateApiKey<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • create_api_key<TResponse, TRequestBody, TContext>(params: SecurityCreateApiKey<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityCreateApiKey<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deletePrivileges:function
    • deletePrivileges<TResponse, TContext>(params?: SecurityDeletePrivileges, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deletePrivileges<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deletePrivileges<TResponse, TContext>(params: SecurityDeletePrivileges, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deletePrivileges<TResponse, TContext>(params: SecurityDeletePrivileges, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • deleteRole:function
    • deleteRole<TResponse, TContext>(params?: SecurityDeleteRole, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteRole<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteRole<TResponse, TContext>(params: SecurityDeleteRole, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteRole<TResponse, TContext>(params: SecurityDeleteRole, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityDeleteRole
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteRoleMapping:function
    • deleteRoleMapping<TResponse, TContext>(params?: SecurityDeleteRoleMapping, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteRoleMapping<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteRoleMapping<TResponse, TContext>(params: SecurityDeleteRoleMapping, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteRoleMapping<TResponse, TContext>(params: SecurityDeleteRoleMapping, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • deleteUser:function
    • deleteUser<TResponse, TContext>(params?: SecurityDeleteUser, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteUser<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteUser<TResponse, TContext>(params: SecurityDeleteUser, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteUser<TResponse, TContext>(params: SecurityDeleteUser, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityDeleteUser
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_privileges:function
    • delete_privileges<TResponse, TContext>(params?: SecurityDeletePrivileges, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_privileges<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_privileges<TResponse, TContext>(params: SecurityDeletePrivileges, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_privileges<TResponse, TContext>(params: SecurityDeletePrivileges, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_role:function
    • delete_role<TResponse, TContext>(params?: SecurityDeleteRole, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_role<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_role<TResponse, TContext>(params: SecurityDeleteRole, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_role<TResponse, TContext>(params: SecurityDeleteRole, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityDeleteRole
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_role_mapping:function
    • delete_role_mapping<TResponse, TContext>(params?: SecurityDeleteRoleMapping, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_role_mapping<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_role_mapping<TResponse, TContext>(params: SecurityDeleteRoleMapping, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_role_mapping<TResponse, TContext>(params: SecurityDeleteRoleMapping, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_user:function
    • delete_user<TResponse, TContext>(params?: SecurityDeleteUser, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_user<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_user<TResponse, TContext>(params: SecurityDeleteUser, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_user<TResponse, TContext>(params: SecurityDeleteUser, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityDeleteUser
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • disableUser:function
    • disableUser<TResponse, TContext>(params?: SecurityDisableUser, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • disableUser<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • disableUser<TResponse, TContext>(params: SecurityDisableUser, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • disableUser<TResponse, TContext>(params: SecurityDisableUser, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityDisableUser
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • disable_user:function
    • disable_user<TResponse, TContext>(params?: SecurityDisableUser, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • disable_user<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • disable_user<TResponse, TContext>(params: SecurityDisableUser, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • disable_user<TResponse, TContext>(params: SecurityDisableUser, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityDisableUser
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • enableUser:function
    • enableUser<TResponse, TContext>(params?: SecurityEnableUser, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • enableUser<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • enableUser<TResponse, TContext>(params: SecurityEnableUser, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • enableUser<TResponse, TContext>(params: SecurityEnableUser, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityEnableUser
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • enable_user:function
    • enable_user<TResponse, TContext>(params?: SecurityEnableUser, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • enable_user<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • enable_user<TResponse, TContext>(params: SecurityEnableUser, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • enable_user<TResponse, TContext>(params: SecurityEnableUser, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityEnableUser
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getApiKey:function
    • getApiKey<TResponse, TContext>(params?: SecurityGetApiKey, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getApiKey<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getApiKey<TResponse, TContext>(params: SecurityGetApiKey, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getApiKey<TResponse, TContext>(params: SecurityGetApiKey, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetApiKey
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getBuiltinPrivileges:function
    • getBuiltinPrivileges<TResponse, TContext>(params?: SecurityGetBuiltinPrivileges, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getBuiltinPrivileges<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getBuiltinPrivileges<TResponse, TContext>(params: SecurityGetBuiltinPrivileges, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getBuiltinPrivileges<TResponse, TContext>(params: SecurityGetBuiltinPrivileges, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getPrivileges:function
    • getPrivileges<TResponse, TContext>(params?: SecurityGetPrivileges, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getPrivileges<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getPrivileges<TResponse, TContext>(params: SecurityGetPrivileges, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getPrivileges<TResponse, TContext>(params: SecurityGetPrivileges, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetPrivileges
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getRole:function
    • getRole<TResponse, TContext>(params?: SecurityGetRole, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SecurityGetRole
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getRole<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getRole<TResponse, TContext>(params: SecurityGetRole, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getRole<TResponse, TContext>(params: SecurityGetRole, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetRole
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getRoleMapping:function
    • getRoleMapping<TResponse, TContext>(params?: SecurityGetRoleMapping, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getRoleMapping<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getRoleMapping<TResponse, TContext>(params: SecurityGetRoleMapping, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getRoleMapping<TResponse, TContext>(params: SecurityGetRoleMapping, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getToken:function
    • getToken<TResponse, TRequestBody, TContext>(params?: SecurityGetToken<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SecurityGetToken<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getToken<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getToken<TResponse, TRequestBody, TContext>(params: SecurityGetToken<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetToken<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getToken<TResponse, TRequestBody, TContext>(params: SecurityGetToken<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetToken<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getUser:function
    • getUser<TResponse, TContext>(params?: SecurityGetUser, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SecurityGetUser
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getUser<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getUser<TResponse, TContext>(params: SecurityGetUser, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getUser<TResponse, TContext>(params: SecurityGetUser, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetUser
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getUserPrivileges:function
    • getUserPrivileges<TResponse, TContext>(params?: SecurityGetUserPrivileges, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getUserPrivileges<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getUserPrivileges<TResponse, TContext>(params: SecurityGetUserPrivileges, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getUserPrivileges<TResponse, TContext>(params: SecurityGetUserPrivileges, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_api_key:function
    • get_api_key<TResponse, TContext>(params?: SecurityGetApiKey, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_api_key<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_api_key<TResponse, TContext>(params: SecurityGetApiKey, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_api_key<TResponse, TContext>(params: SecurityGetApiKey, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetApiKey
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_builtin_privileges:function
    • get_builtin_privileges<TResponse, TContext>(params?: SecurityGetBuiltinPrivileges, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_builtin_privileges<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_builtin_privileges<TResponse, TContext>(params: SecurityGetBuiltinPrivileges, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_builtin_privileges<TResponse, TContext>(params: SecurityGetBuiltinPrivileges, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_privileges:function
    • get_privileges<TResponse, TContext>(params?: SecurityGetPrivileges, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_privileges<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_privileges<TResponse, TContext>(params: SecurityGetPrivileges, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_privileges<TResponse, TContext>(params: SecurityGetPrivileges, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetPrivileges
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_role:function
    • get_role<TResponse, TContext>(params?: SecurityGetRole, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SecurityGetRole
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_role<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_role<TResponse, TContext>(params: SecurityGetRole, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_role<TResponse, TContext>(params: SecurityGetRole, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetRole
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_role_mapping:function
    • get_role_mapping<TResponse, TContext>(params?: SecurityGetRoleMapping, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_role_mapping<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_role_mapping<TResponse, TContext>(params: SecurityGetRoleMapping, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_role_mapping<TResponse, TContext>(params: SecurityGetRoleMapping, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_token:function
    • get_token<TResponse, TRequestBody, TContext>(params?: SecurityGetToken<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SecurityGetToken<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_token<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_token<TResponse, TRequestBody, TContext>(params: SecurityGetToken<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetToken<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_token<TResponse, TRequestBody, TContext>(params: SecurityGetToken<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetToken<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_user:function
    • get_user<TResponse, TContext>(params?: SecurityGetUser, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SecurityGetUser
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_user<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_user<TResponse, TContext>(params: SecurityGetUser, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_user<TResponse, TContext>(params: SecurityGetUser, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGetUser
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_user_privileges:function
    • get_user_privileges<TResponse, TContext>(params?: SecurityGetUserPrivileges, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_user_privileges<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_user_privileges<TResponse, TContext>(params: SecurityGetUserPrivileges, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_user_privileges<TResponse, TContext>(params: SecurityGetUserPrivileges, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • grantApiKey:function
    • grantApiKey<TResponse, TRequestBody, TContext>(params?: SecurityGrantApiKey<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • grantApiKey<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • grantApiKey<TResponse, TRequestBody, TContext>(params: SecurityGrantApiKey<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • grantApiKey<TResponse, TRequestBody, TContext>(params: SecurityGrantApiKey<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGrantApiKey<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • grant_api_key:function
    • grant_api_key<TResponse, TRequestBody, TContext>(params?: SecurityGrantApiKey<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • grant_api_key<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • grant_api_key<TResponse, TRequestBody, TContext>(params: SecurityGrantApiKey<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • grant_api_key<TResponse, TRequestBody, TContext>(params: SecurityGrantApiKey<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityGrantApiKey<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • hasPrivileges:function
    • hasPrivileges<TResponse, TRequestBody, TContext>(params?: SecurityHasPrivileges<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • hasPrivileges<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • hasPrivileges<TResponse, TRequestBody, TContext>(params: SecurityHasPrivileges<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • hasPrivileges<TResponse, TRequestBody, TContext>(params: SecurityHasPrivileges<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityHasPrivileges<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • has_privileges:function
    • has_privileges<TResponse, TRequestBody, TContext>(params?: SecurityHasPrivileges<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • has_privileges<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • has_privileges<TResponse, TRequestBody, TContext>(params: SecurityHasPrivileges<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • has_privileges<TResponse, TRequestBody, TContext>(params: SecurityHasPrivileges<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityHasPrivileges<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • invalidateApiKey:function
    • invalidateApiKey<TResponse, TRequestBody, TContext>(params?: SecurityInvalidateApiKey<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • invalidateApiKey<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • invalidateApiKey<TResponse, TRequestBody, TContext>(params: SecurityInvalidateApiKey<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • invalidateApiKey<TResponse, TRequestBody, TContext>(params: SecurityInvalidateApiKey<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityInvalidateApiKey<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • invalidateToken:function
    • invalidateToken<TResponse, TRequestBody, TContext>(params?: SecurityInvalidateToken<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • invalidateToken<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • invalidateToken<TResponse, TRequestBody, TContext>(params: SecurityInvalidateToken<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • invalidateToken<TResponse, TRequestBody, TContext>(params: SecurityInvalidateToken<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityInvalidateToken<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • invalidate_api_key:function
    • invalidate_api_key<TResponse, TRequestBody, TContext>(params?: SecurityInvalidateApiKey<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • invalidate_api_key<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • invalidate_api_key<TResponse, TRequestBody, TContext>(params: SecurityInvalidateApiKey<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • invalidate_api_key<TResponse, TRequestBody, TContext>(params: SecurityInvalidateApiKey<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityInvalidateApiKey<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • invalidate_token:function
    • invalidate_token<TResponse, TRequestBody, TContext>(params?: SecurityInvalidateToken<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • invalidate_token<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • invalidate_token<TResponse, TRequestBody, TContext>(params: SecurityInvalidateToken<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • invalidate_token<TResponse, TRequestBody, TContext>(params: SecurityInvalidateToken<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityInvalidateToken<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putPrivileges:function
    • putPrivileges<TResponse, TRequestBody, TContext>(params?: SecurityPutPrivileges<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putPrivileges<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putPrivileges<TResponse, TRequestBody, TContext>(params: SecurityPutPrivileges<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putPrivileges<TResponse, TRequestBody, TContext>(params: SecurityPutPrivileges<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutPrivileges<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putRole:function
    • putRole<TResponse, TRequestBody, TContext>(params?: SecurityPutRole<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SecurityPutRole<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putRole<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putRole<TResponse, TRequestBody, TContext>(params: SecurityPutRole<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutRole<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putRole<TResponse, TRequestBody, TContext>(params: SecurityPutRole<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutRole<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putRoleMapping:function
    • putRoleMapping<TResponse, TRequestBody, TContext>(params?: SecurityPutRoleMapping<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putRoleMapping<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putRoleMapping<TResponse, TRequestBody, TContext>(params: SecurityPutRoleMapping<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putRoleMapping<TResponse, TRequestBody, TContext>(params: SecurityPutRoleMapping<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutRoleMapping<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putUser:function
    • putUser<TResponse, TRequestBody, TContext>(params?: SecurityPutUser<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SecurityPutUser<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putUser<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putUser<TResponse, TRequestBody, TContext>(params: SecurityPutUser<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutUser<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putUser<TResponse, TRequestBody, TContext>(params: SecurityPutUser<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutUser<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_privileges:function
    • put_privileges<TResponse, TRequestBody, TContext>(params?: SecurityPutPrivileges<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_privileges<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_privileges<TResponse, TRequestBody, TContext>(params: SecurityPutPrivileges<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_privileges<TResponse, TRequestBody, TContext>(params: SecurityPutPrivileges<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutPrivileges<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_role:function
    • put_role<TResponse, TRequestBody, TContext>(params?: SecurityPutRole<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SecurityPutRole<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_role<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_role<TResponse, TRequestBody, TContext>(params: SecurityPutRole<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutRole<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_role<TResponse, TRequestBody, TContext>(params: SecurityPutRole<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutRole<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_role_mapping:function
    • put_role_mapping<TResponse, TRequestBody, TContext>(params?: SecurityPutRoleMapping<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_role_mapping<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_role_mapping<TResponse, TRequestBody, TContext>(params: SecurityPutRoleMapping<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_role_mapping<TResponse, TRequestBody, TContext>(params: SecurityPutRoleMapping<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutRoleMapping<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_user:function
    • put_user<TResponse, TRequestBody, TContext>(params?: SecurityPutUser<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SecurityPutUser<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_user<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_user<TResponse, TRequestBody, TContext>(params: SecurityPutUser<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutUser<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_user<TResponse, TRequestBody, TContext>(params: SecurityPutUser<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SecurityPutUser<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

serializer

serializer: Serializer

slm

slm: { deleteLifecycle: any; delete_lifecycle: any; executeLifecycle: any; executeRetention: any; execute_lifecycle: any; execute_retention: any; getLifecycle: any; getStats: any; getStatus: any; get_lifecycle: any; get_stats: any; get_status: any; putLifecycle: any; put_lifecycle: any; start: any; stop: any }

Type declaration

  • deleteLifecycle:function
    • deleteLifecycle<TResponse, TContext>(params?: SlmDeleteLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteLifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteLifecycle<TResponse, TContext>(params: SlmDeleteLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteLifecycle<TResponse, TContext>(params: SlmDeleteLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmDeleteLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_lifecycle:function
    • delete_lifecycle<TResponse, TContext>(params?: SlmDeleteLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_lifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_lifecycle<TResponse, TContext>(params: SlmDeleteLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_lifecycle<TResponse, TContext>(params: SlmDeleteLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmDeleteLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • executeLifecycle:function
    • executeLifecycle<TResponse, TContext>(params?: SlmExecuteLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • executeLifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • executeLifecycle<TResponse, TContext>(params: SlmExecuteLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • executeLifecycle<TResponse, TContext>(params: SlmExecuteLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmExecuteLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • executeRetention:function
    • executeRetention<TResponse, TContext>(params?: SlmExecuteRetention, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • executeRetention<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • executeRetention<TResponse, TContext>(params: SlmExecuteRetention, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • executeRetention<TResponse, TContext>(params: SlmExecuteRetention, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmExecuteRetention
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • execute_lifecycle:function
    • execute_lifecycle<TResponse, TContext>(params?: SlmExecuteLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • execute_lifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • execute_lifecycle<TResponse, TContext>(params: SlmExecuteLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • execute_lifecycle<TResponse, TContext>(params: SlmExecuteLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmExecuteLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • execute_retention:function
    • execute_retention<TResponse, TContext>(params?: SlmExecuteRetention, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • execute_retention<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • execute_retention<TResponse, TContext>(params: SlmExecuteRetention, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • execute_retention<TResponse, TContext>(params: SlmExecuteRetention, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmExecuteRetention
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getLifecycle:function
    • getLifecycle<TResponse, TContext>(params?: SlmGetLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SlmGetLifecycle
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getLifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getLifecycle<TResponse, TContext>(params: SlmGetLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getLifecycle<TResponse, TContext>(params: SlmGetLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmGetLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getStats:function
    • getStats<TResponse, TContext>(params?: SlmGetStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SlmGetStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getStats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getStats<TResponse, TContext>(params: SlmGetStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmGetStats
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getStats<TResponse, TContext>(params: SlmGetStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmGetStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getStatus:function
    • getStatus<TResponse, TContext>(params?: SlmGetStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SlmGetStatus
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getStatus<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getStatus<TResponse, TContext>(params: SlmGetStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmGetStatus
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getStatus<TResponse, TContext>(params: SlmGetStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmGetStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_lifecycle:function
    • get_lifecycle<TResponse, TContext>(params?: SlmGetLifecycle, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SlmGetLifecycle
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_lifecycle<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_lifecycle<TResponse, TContext>(params: SlmGetLifecycle, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_lifecycle<TResponse, TContext>(params: SlmGetLifecycle, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmGetLifecycle
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_stats:function
    • get_stats<TResponse, TContext>(params?: SlmGetStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SlmGetStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_stats<TResponse, TContext>(params: SlmGetStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmGetStats
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_stats<TResponse, TContext>(params: SlmGetStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmGetStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_status:function
    • get_status<TResponse, TContext>(params?: SlmGetStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SlmGetStatus
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_status<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_status<TResponse, TContext>(params: SlmGetStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmGetStatus
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_status<TResponse, TContext>(params: SlmGetStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmGetStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putLifecycle:function
    • putLifecycle<TResponse, TRequestBody, TContext>(params?: SlmPutLifecycle<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SlmPutLifecycle<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putLifecycle<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putLifecycle<TResponse, TRequestBody, TContext>(params: SlmPutLifecycle<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmPutLifecycle<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putLifecycle<TResponse, TRequestBody, TContext>(params: SlmPutLifecycle<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmPutLifecycle<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_lifecycle:function
    • put_lifecycle<TResponse, TRequestBody, TContext>(params?: SlmPutLifecycle<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SlmPutLifecycle<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_lifecycle<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_lifecycle<TResponse, TRequestBody, TContext>(params: SlmPutLifecycle<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmPutLifecycle<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_lifecycle<TResponse, TRequestBody, TContext>(params: SlmPutLifecycle<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmPutLifecycle<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • start:function
    • start<TResponse, TContext>(params?: SlmStart, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SlmStart
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • start<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start<TResponse, TContext>(params: SlmStart, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmStart
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start<TResponse, TContext>(params: SlmStart, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmStart
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stop:function
    • stop<TResponse, TContext>(params?: SlmStop, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SlmStop
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stop<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop<TResponse, TContext>(params: SlmStop, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmStop
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop<TResponse, TContext>(params: SlmStop, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SlmStop
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

snapshot

snapshot: { cleanupRepository: any; cleanup_repository: any; clone: any; create: any; createRepository: any; create_repository: any; delete: any; deleteRepository: any; delete_repository: any; get: any; getRepository: any; get_repository: any; restore: any; status: any; verifyRepository: any; verify_repository: any }

Type declaration

  • cleanupRepository:function
    • cleanupRepository<TResponse, TContext>(params?: SnapshotCleanupRepository, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • cleanupRepository<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • cleanupRepository<TResponse, TContext>(params: SnapshotCleanupRepository, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • cleanupRepository<TResponse, TContext>(params: SnapshotCleanupRepository, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • cleanup_repository:function
    • cleanup_repository<TResponse, TContext>(params?: SnapshotCleanupRepository, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • cleanup_repository<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • cleanup_repository<TResponse, TContext>(params: SnapshotCleanupRepository, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • cleanup_repository<TResponse, TContext>(params: SnapshotCleanupRepository, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • clone:function
    • clone<TResponse, TRequestBody, TContext>(params?: SnapshotClone<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SnapshotClone<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clone<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clone<TResponse, TRequestBody, TContext>(params: SnapshotClone<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotClone<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clone<TResponse, TRequestBody, TContext>(params: SnapshotClone<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotClone<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • create:function
    • create<TResponse, TRequestBody, TContext>(params?: SnapshotCreate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SnapshotCreate<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • create<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • create<TResponse, TRequestBody, TContext>(params: SnapshotCreate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotCreate<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • create<TResponse, TRequestBody, TContext>(params: SnapshotCreate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotCreate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • createRepository:function
    • createRepository<TResponse, TRequestBody, TContext>(params?: SnapshotCreateRepository<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • createRepository<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • createRepository<TResponse, TRequestBody, TContext>(params: SnapshotCreateRepository<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • createRepository<TResponse, TRequestBody, TContext>(params: SnapshotCreateRepository<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotCreateRepository<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • create_repository:function
    • create_repository<TResponse, TRequestBody, TContext>(params?: SnapshotCreateRepository<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • create_repository<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • create_repository<TResponse, TRequestBody, TContext>(params: SnapshotCreateRepository<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • create_repository<TResponse, TRequestBody, TContext>(params: SnapshotCreateRepository<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotCreateRepository<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete:function
    • delete<TResponse, TContext>(params?: SnapshotDelete, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SnapshotDelete
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: SnapshotDelete, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete<TResponse, TContext>(params: SnapshotDelete, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotDelete
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deleteRepository:function
    • deleteRepository<TResponse, TContext>(params?: SnapshotDeleteRepository, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteRepository<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteRepository<TResponse, TContext>(params: SnapshotDeleteRepository, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteRepository<TResponse, TContext>(params: SnapshotDeleteRepository, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_repository:function
    • delete_repository<TResponse, TContext>(params?: SnapshotDeleteRepository, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_repository<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_repository<TResponse, TContext>(params: SnapshotDeleteRepository, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_repository<TResponse, TContext>(params: SnapshotDeleteRepository, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get:function
    • get<TResponse, TContext>(params?: SnapshotGet, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SnapshotGet
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: SnapshotGet, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotGet
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: SnapshotGet, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotGet
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getRepository:function
    • getRepository<TResponse, TContext>(params?: SnapshotGetRepository, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getRepository<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getRepository<TResponse, TContext>(params: SnapshotGetRepository, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getRepository<TResponse, TContext>(params: SnapshotGetRepository, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotGetRepository
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_repository:function
    • get_repository<TResponse, TContext>(params?: SnapshotGetRepository, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_repository<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_repository<TResponse, TContext>(params: SnapshotGetRepository, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_repository<TResponse, TContext>(params: SnapshotGetRepository, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotGetRepository
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • restore:function
    • restore<TResponse, TRequestBody, TContext>(params?: SnapshotRestore<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SnapshotRestore<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • restore<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • restore<TResponse, TRequestBody, TContext>(params: SnapshotRestore<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotRestore<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • restore<TResponse, TRequestBody, TContext>(params: SnapshotRestore<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotRestore<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • status:function
    • status<TResponse, TContext>(params?: SnapshotStatus, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SnapshotStatus
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • status<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • status<TResponse, TContext>(params: SnapshotStatus, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • status<TResponse, TContext>(params: SnapshotStatus, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SnapshotStatus
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • verifyRepository:function
    • verifyRepository<TResponse, TContext>(params?: SnapshotVerifyRepository, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • verifyRepository<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • verifyRepository<TResponse, TContext>(params: SnapshotVerifyRepository, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • verifyRepository<TResponse, TContext>(params: SnapshotVerifyRepository, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • verify_repository:function
    • verify_repository<TResponse, TContext>(params?: SnapshotVerifyRepository, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • verify_repository<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • verify_repository<TResponse, TContext>(params: SnapshotVerifyRepository, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • verify_repository<TResponse, TContext>(params: SnapshotVerifyRepository, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

sql

sql: { clearCursor: any; clear_cursor: any; query: any; translate: any }

Type declaration

  • clearCursor:function
    • clearCursor<TResponse, TRequestBody, TContext>(params?: SqlClearCursor<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SqlClearCursor<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clearCursor<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clearCursor<TResponse, TRequestBody, TContext>(params: SqlClearCursor<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SqlClearCursor<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clearCursor<TResponse, TRequestBody, TContext>(params: SqlClearCursor<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SqlClearCursor<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • clear_cursor:function
    • clear_cursor<TResponse, TRequestBody, TContext>(params?: SqlClearCursor<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SqlClearCursor<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • clear_cursor<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clear_cursor<TResponse, TRequestBody, TContext>(params: SqlClearCursor<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SqlClearCursor<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • clear_cursor<TResponse, TRequestBody, TContext>(params: SqlClearCursor<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SqlClearCursor<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • query:function
    • query<TResponse, TRequestBody, TContext>(params?: SqlQuery<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SqlQuery<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • query<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • query<TResponse, TRequestBody, TContext>(params: SqlQuery<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SqlQuery<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • query<TResponse, TRequestBody, TContext>(params: SqlQuery<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SqlQuery<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • translate:function
    • translate<TResponse, TRequestBody, TContext>(params?: SqlTranslate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SqlTranslate<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • translate<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • translate<TResponse, TRequestBody, TContext>(params: SqlTranslate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SqlTranslate<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • translate<TResponse, TRequestBody, TContext>(params: SqlTranslate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SqlTranslate<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

ssl

ssl: { certificates: any }

Type declaration

  • certificates:function
    • certificates<TResponse, TContext>(params?: SslCertificates, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: SslCertificates
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • certificates<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • certificates<TResponse, TContext>(params: SslCertificates, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • certificates<TResponse, TContext>(params: SslCertificates, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: SslCertificates
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

tasks

tasks: { cancel: any; get: any; list: any }

Type declaration

  • cancel:function
    • cancel<TResponse, TContext>(params?: TasksCancel, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: TasksCancel
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • cancel<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • cancel<TResponse, TContext>(params: TasksCancel, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TasksCancel
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • cancel<TResponse, TContext>(params: TasksCancel, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TasksCancel
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get:function
    • get<TResponse, TContext>(params?: TasksGet, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: TasksGet
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: TasksGet, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TasksGet
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get<TResponse, TContext>(params: TasksGet, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TasksGet
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • list:function
    • list<TResponse, TContext>(params?: TasksList, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: TasksList
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • list<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • list<TResponse, TContext>(params: TasksList, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TasksList
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • list<TResponse, TContext>(params: TasksList, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TasksList
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

textStructure

textStructure: { findStructure: any; find_structure: any }

Type declaration

  • findStructure:function
    • findStructure<TResponse, TRequestBody, TContext>(params?: TextStructureFindStructure<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • findStructure<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • findStructure<TResponse, TRequestBody, TContext>(params: TextStructureFindStructure<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • findStructure<TResponse, TRequestBody, TContext>(params: TextStructureFindStructure<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • find_structure:function
    • find_structure<TResponse, TRequestBody, TContext>(params?: TextStructureFindStructure<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • find_structure<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • find_structure<TResponse, TRequestBody, TContext>(params: TextStructureFindStructure<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • find_structure<TResponse, TRequestBody, TContext>(params: TextStructureFindStructure<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

text_structure

text_structure: { findStructure: any; find_structure: any }

Type declaration

  • findStructure:function
    • findStructure<TResponse, TRequestBody, TContext>(params?: TextStructureFindStructure<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • findStructure<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • findStructure<TResponse, TRequestBody, TContext>(params: TextStructureFindStructure<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • findStructure<TResponse, TRequestBody, TContext>(params: TextStructureFindStructure<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • find_structure:function
    • find_structure<TResponse, TRequestBody, TContext>(params?: TextStructureFindStructure<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • find_structure<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • find_structure<TResponse, TRequestBody, TContext>(params: TextStructureFindStructure<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • find_structure<TResponse, TRequestBody, TContext>(params: TextStructureFindStructure<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

transform

transform: { deleteTransform: any; delete_transform: any; getTransform: any; getTransformStats: any; get_transform: any; get_transform_stats: any; previewTransform: any; preview_transform: any; putTransform: any; put_transform: any; startTransform: any; start_transform: any; stopTransform: any; stop_transform: any; updateTransform: any; update_transform: any }

Type declaration

  • deleteTransform:function
    • deleteTransform<TResponse, TContext>(params?: TransformDeleteTransform, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteTransform<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteTransform<TResponse, TContext>(params: TransformDeleteTransform, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteTransform<TResponse, TContext>(params: TransformDeleteTransform, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • delete_transform:function
    • delete_transform<TResponse, TContext>(params?: TransformDeleteTransform, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_transform<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_transform<TResponse, TContext>(params: TransformDeleteTransform, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_transform<TResponse, TContext>(params: TransformDeleteTransform, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • getTransform:function
    • getTransform<TResponse, TContext>(params?: TransformGetTransform, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getTransform<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getTransform<TResponse, TContext>(params: TransformGetTransform, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getTransform<TResponse, TContext>(params: TransformGetTransform, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TransformGetTransform
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getTransformStats:function
    • getTransformStats<TResponse, TContext>(params?: TransformGetTransformStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getTransformStats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getTransformStats<TResponse, TContext>(params: TransformGetTransformStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getTransformStats<TResponse, TContext>(params: TransformGetTransformStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • get_transform:function
    • get_transform<TResponse, TContext>(params?: TransformGetTransform, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_transform<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_transform<TResponse, TContext>(params: TransformGetTransform, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_transform<TResponse, TContext>(params: TransformGetTransform, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TransformGetTransform
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_transform_stats:function
    • get_transform_stats<TResponse, TContext>(params?: TransformGetTransformStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_transform_stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_transform_stats<TResponse, TContext>(params: TransformGetTransformStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_transform_stats<TResponse, TContext>(params: TransformGetTransformStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • previewTransform:function
    • previewTransform<TResponse, TRequestBody, TContext>(params?: TransformPreviewTransform<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • previewTransform<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • previewTransform<TResponse, TRequestBody, TContext>(params: TransformPreviewTransform<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • previewTransform<TResponse, TRequestBody, TContext>(params: TransformPreviewTransform<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • preview_transform:function
    • preview_transform<TResponse, TRequestBody, TContext>(params?: TransformPreviewTransform<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • preview_transform<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • preview_transform<TResponse, TRequestBody, TContext>(params: TransformPreviewTransform<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • preview_transform<TResponse, TRequestBody, TContext>(params: TransformPreviewTransform<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • putTransform:function
    • putTransform<TResponse, TRequestBody, TContext>(params?: TransformPutTransform<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putTransform<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putTransform<TResponse, TRequestBody, TContext>(params: TransformPutTransform<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • putTransform<TResponse, TRequestBody, TContext>(params: TransformPutTransform<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TransformPutTransform<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_transform:function
    • put_transform<TResponse, TRequestBody, TContext>(params?: TransformPutTransform<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_transform<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_transform<TResponse, TRequestBody, TContext>(params: TransformPutTransform<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • put_transform<TResponse, TRequestBody, TContext>(params: TransformPutTransform<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TransformPutTransform<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • startTransform:function
    • startTransform<TResponse, TContext>(params?: TransformStartTransform, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • startTransform<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • startTransform<TResponse, TContext>(params: TransformStartTransform, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • startTransform<TResponse, TContext>(params: TransformStartTransform, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • start_transform:function
    • start_transform<TResponse, TContext>(params?: TransformStartTransform, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • start_transform<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start_transform<TResponse, TContext>(params: TransformStartTransform, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • start_transform<TResponse, TContext>(params: TransformStartTransform, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • stopTransform:function
    • stopTransform<TResponse, TContext>(params?: TransformStopTransform, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stopTransform<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stopTransform<TResponse, TContext>(params: TransformStopTransform, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • stopTransform<TResponse, TContext>(params: TransformStopTransform, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • stop_transform:function
    • stop_transform<TResponse, TContext>(params?: TransformStopTransform, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stop_transform<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop_transform<TResponse, TContext>(params: TransformStopTransform, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • stop_transform<TResponse, TContext>(params: TransformStopTransform, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • updateTransform:function
    • updateTransform<TResponse, TRequestBody, TContext>(params?: TransformUpdateTransform<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • updateTransform<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • updateTransform<TResponse, TRequestBody, TContext>(params: TransformUpdateTransform<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • updateTransform<TResponse, TRequestBody, TContext>(params: TransformUpdateTransform<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TransformUpdateTransform<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • update_transform:function
    • update_transform<TResponse, TRequestBody, TContext>(params?: TransformUpdateTransform<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • update_transform<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • update_transform<TResponse, TRequestBody, TContext>(params: TransformUpdateTransform<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • update_transform<TResponse, TRequestBody, TContext>(params: TransformUpdateTransform<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: TransformUpdateTransform<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

transport

transport: Transport

watcher

watcher: { ackWatch: any; ack_watch: any; activateWatch: any; activate_watch: any; deactivateWatch: any; deactivate_watch: any; deleteWatch: any; delete_watch: any; executeWatch: any; execute_watch: any; getWatch: any; get_watch: any; putWatch: any; put_watch: any; queryWatches: any; query_watches: any; start: any; stats: any; stop: any }

Type declaration

  • ackWatch:function
    • ackWatch<TResponse, TContext>(params?: WatcherAckWatch, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: WatcherAckWatch
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • ackWatch<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • ackWatch<TResponse, TContext>(params: WatcherAckWatch, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • ackWatch<TResponse, TContext>(params: WatcherAckWatch, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherAckWatch
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • ack_watch:function
    • ack_watch<TResponse, TContext>(params?: WatcherAckWatch, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: WatcherAckWatch
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • ack_watch<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • ack_watch<TResponse, TContext>(params: WatcherAckWatch, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • ack_watch<TResponse, TContext>(params: WatcherAckWatch, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherAckWatch
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • activateWatch:function
    • activateWatch<TResponse, TContext>(params?: WatcherActivateWatch, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • activateWatch<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • activateWatch<TResponse, TContext>(params: WatcherActivateWatch, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • activateWatch<TResponse, TContext>(params: WatcherActivateWatch, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherActivateWatch
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • activate_watch:function
    • activate_watch<TResponse, TContext>(params?: WatcherActivateWatch, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • activate_watch<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • activate_watch<TResponse, TContext>(params: WatcherActivateWatch, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • activate_watch<TResponse, TContext>(params: WatcherActivateWatch, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherActivateWatch
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • deactivateWatch:function
    • deactivateWatch<TResponse, TContext>(params?: WatcherDeactivateWatch, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deactivateWatch<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deactivateWatch<TResponse, TContext>(params: WatcherDeactivateWatch, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deactivateWatch<TResponse, TContext>(params: WatcherDeactivateWatch, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • deactivate_watch:function
    • deactivate_watch<TResponse, TContext>(params?: WatcherDeactivateWatch, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deactivate_watch<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deactivate_watch<TResponse, TContext>(params: WatcherDeactivateWatch, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deactivate_watch<TResponse, TContext>(params: WatcherDeactivateWatch, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

  • deleteWatch:function
    • deleteWatch<TResponse, TContext>(params?: WatcherDeleteWatch, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • deleteWatch<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • deleteWatch<TResponse, TContext>(params: WatcherDeleteWatch, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • deleteWatch<TResponse, TContext>(params: WatcherDeleteWatch, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherDeleteWatch
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • delete_watch:function
    • delete_watch<TResponse, TContext>(params?: WatcherDeleteWatch, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • delete_watch<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • delete_watch<TResponse, TContext>(params: WatcherDeleteWatch, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • delete_watch<TResponse, TContext>(params: WatcherDeleteWatch, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherDeleteWatch
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • executeWatch:function
    • executeWatch<TResponse, TRequestBody, TContext>(params?: WatcherExecuteWatch<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • executeWatch<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • executeWatch<TResponse, TRequestBody, TContext>(params: WatcherExecuteWatch<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • executeWatch<TResponse, TRequestBody, TContext>(params: WatcherExecuteWatch<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherExecuteWatch<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • execute_watch:function
    • execute_watch<TResponse, TRequestBody, TContext>(params?: WatcherExecuteWatch<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • execute_watch<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • execute_watch<TResponse, TRequestBody, TContext>(params: WatcherExecuteWatch<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • execute_watch<TResponse, TRequestBody, TContext>(params: WatcherExecuteWatch<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherExecuteWatch<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • getWatch:function
    • getWatch<TResponse, TContext>(params?: WatcherGetWatch, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: WatcherGetWatch
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • getWatch<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • getWatch<TResponse, TContext>(params: WatcherGetWatch, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • getWatch<TResponse, TContext>(params: WatcherGetWatch, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherGetWatch
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • get_watch:function
    • get_watch<TResponse, TContext>(params?: WatcherGetWatch, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: WatcherGetWatch
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • get_watch<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • get_watch<TResponse, TContext>(params: WatcherGetWatch, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • get_watch<TResponse, TContext>(params: WatcherGetWatch, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherGetWatch
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • putWatch:function
    • putWatch<TResponse, TRequestBody, TContext>(params?: WatcherPutWatch<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: WatcherPutWatch<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • putWatch<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putWatch<TResponse, TRequestBody, TContext>(params: WatcherPutWatch<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherPutWatch<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • putWatch<TResponse, TRequestBody, TContext>(params: WatcherPutWatch<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherPutWatch<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • put_watch:function
    • put_watch<TResponse, TRequestBody, TContext>(params?: WatcherPutWatch<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: WatcherPutWatch<TRequestBody>
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • put_watch<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_watch<TResponse, TRequestBody, TContext>(params: WatcherPutWatch<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherPutWatch<TRequestBody>
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • put_watch<TResponse, TRequestBody, TContext>(params: WatcherPutWatch<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherPutWatch<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • queryWatches:function
    • queryWatches<TResponse, TRequestBody, TContext>(params?: WatcherQueryWatches<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • queryWatches<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • queryWatches<TResponse, TRequestBody, TContext>(params: WatcherQueryWatches<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • queryWatches<TResponse, TRequestBody, TContext>(params: WatcherQueryWatches<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherQueryWatches<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • query_watches:function
    • query_watches<TResponse, TRequestBody, TContext>(params?: WatcherQueryWatches<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • query_watches<TResponse, TRequestBody, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • query_watches<TResponse, TRequestBody, TContext>(params: WatcherQueryWatches<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      Returns TransportRequestCallback

    • query_watches<TResponse, TRequestBody, TContext>(params: WatcherQueryWatches<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherQueryWatches<TRequestBody>
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • start:function
    • start<TResponse, TContext>(params?: WatcherStart, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: WatcherStart
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • start<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start<TResponse, TContext>(params: WatcherStart, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherStart
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • start<TResponse, TContext>(params: WatcherStart, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherStart
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stats:function
    • stats<TResponse, TContext>(params?: WatcherStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: WatcherStats
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stats<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: WatcherStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherStats
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stats<TResponse, TContext>(params: WatcherStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherStats
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • stop:function
    • stop<TResponse, TContext>(params?: WatcherStop, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: WatcherStop
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • stop<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop<TResponse, TContext>(params: WatcherStop, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherStop
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • stop<TResponse, TContext>(params: WatcherStop, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: WatcherStop
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

xpack

xpack: { info: any; usage: any }

Type declaration

  • info:function
    • info<TResponse, TContext>(params?: XpackInfo, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: XpackInfo
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • info<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • info<TResponse, TContext>(params: XpackInfo, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: XpackInfo
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • info<TResponse, TContext>(params: XpackInfo, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: XpackInfo
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

  • usage:function
    • usage<TResponse, TContext>(params?: XpackUsage, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • Optional params: XpackUsage
      • Optional options: TransportRequestOptions

      Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

    • usage<TResponse, TContext>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • usage<TResponse, TContext>(params: XpackUsage, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: XpackUsage
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

    • usage<TResponse, TContext>(params: XpackUsage, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback

    • Type Parameters

      • TResponse = Record<string, any>

      • TContext = Record<string, unknown>

      Parameters

      • params: XpackUsage
      • options: TransportRequestOptions
      • callback: callbackFn<TResponse, TContext>

      Returns TransportRequestCallback

Methods

bulk

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Bulk<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • params: Bulk<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • params: Bulk<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

child

clearScroll

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: ClearScroll<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ClearScroll<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ClearScroll<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

clear_scroll

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: ClearScroll<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ClearScroll<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ClearScroll<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

close

  • Returns Promise<void>

  • Parameters

    • callback: Function

    Returns void

  • Parameters

    • Optional callback: Function

    Returns void | Promise<void>

closePointInTime

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: ClosePointInTime<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ClosePointInTime<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ClosePointInTime<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

close_point_in_time

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: ClosePointInTime<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ClosePointInTime<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ClosePointInTime<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

count

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Count<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Count<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Count<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

create

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Create<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Create<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Create<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

delete

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Delete
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Delete
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Delete
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

deleteByQuery

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: DeleteByQuery<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: DeleteByQuery<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: DeleteByQuery<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

deleteByQueryRethrottle

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

deleteScript

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: DeleteScript
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: DeleteScript
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: DeleteScript
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

delete_by_query

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: DeleteByQuery<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: DeleteByQuery<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: DeleteByQuery<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

delete_by_query_rethrottle

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

delete_script

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: DeleteScript
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: DeleteScript
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: DeleteScript
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

emit

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

exists

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Exists
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • params: Exists
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • params: Exists
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

existsSource

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: ExistsSource
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • params: ExistsSource
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • params: ExistsSource
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

exists_source

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: ExistsSource
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • params: ExistsSource
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • params: ExistsSource
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

explain

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Explain<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Explain<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Explain<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

extend

  • Parameters

    • method: string
    • fn: extendsCallback

    Returns void

  • Parameters

    • method: string
    • opts: { force: boolean }
      • force: boolean
    • fn: extendsCallback

    Returns void

fieldCaps

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: FieldCaps<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: FieldCaps<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: FieldCaps<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

field_caps

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: FieldCaps<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: FieldCaps<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: FieldCaps<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

get

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Get
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Get
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Get
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

getScript

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: GetScript
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetScript
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetScript
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

getScriptContext

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetScriptContext
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

getScriptLanguages

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetScriptLanguages
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

getSource

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: GetSource
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetSource
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetSource
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

get_script

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: GetScript
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetScript
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetScript
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

get_script_context

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetScriptContext
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

get_script_languages

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetScriptLanguages
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

get_source

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: GetSource
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetSource
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: GetSource
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

index

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Index<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Index<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Index<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

info

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Info
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Info
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Info
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

mget

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Mget<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Mget<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Mget<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

msearch

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Msearch<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • params: Msearch<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • params: Msearch<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

msearchTemplate

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: MsearchTemplate<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • params: MsearchTemplate<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • params: MsearchTemplate<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

msearch_template

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: MsearchTemplate<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • params: MsearchTemplate<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestNDBody<Record<string, any>[]> = Record<string, any>[]

    • TContext = Record<string, unknown>

    Parameters

    • params: MsearchTemplate<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

mtermvectors

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Mtermvectors<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Mtermvectors<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Mtermvectors<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

off

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

on

  • Parameters

    • event: "request"
    • listener: ((err: ApiError, meta: RequestEvent<Record<string, any>, Record<string, unknown>>) => void)

    Returns Client

  • Parameters

    • event: "response"
    • listener: ((err: ApiError, meta: RequestEvent<Record<string, any>, Record<string, unknown>>) => void)

    Returns Client

  • Parameters

    • event: "sniff"
    • listener: ((err: ApiError, meta: RequestEvent<Record<string, any>, Record<string, unknown>>) => void)

    Returns Client

  • Parameters

    Returns Client

once

  • Parameters

    • event: "request"
    • listener: ((err: ApiError, meta: RequestEvent<Record<string, any>, Record<string, unknown>>) => void)

    Returns Client

  • Parameters

    • event: "response"
    • listener: ((err: ApiError, meta: RequestEvent<Record<string, any>, Record<string, unknown>>) => void)

    Returns Client

  • Parameters

    • event: "sniff"
    • listener: ((err: ApiError, meta: RequestEvent<Record<string, any>, Record<string, unknown>>) => void)

    Returns Client

  • Parameters

    Returns Client

openPointInTime

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: OpenPointInTime
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: OpenPointInTime
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

open_point_in_time

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: OpenPointInTime
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: OpenPointInTime
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

ping

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Ping
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • params: Ping
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = boolean

    • TContext = Record<string, unknown>

    Parameters

    • params: Ping
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

putScript

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: PutScript<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: PutScript<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: PutScript<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

put_script

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: PutScript<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: PutScript<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: PutScript<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

rankEval

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: RankEval<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: RankEval<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: RankEval<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

rank_eval

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: RankEval<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: RankEval<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: RankEval<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

reindex

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Reindex<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Reindex<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Reindex<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

reindexRethrottle

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ReindexRethrottle
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

reindex_rethrottle

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ReindexRethrottle
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

renderSearchTemplate

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: RenderSearchTemplate<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

render_search_template

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: RenderSearchTemplate<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

scriptsPainlessExecute

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ScriptsPainlessExecute<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

scripts_painless_execute

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: ScriptsPainlessExecute<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

scroll

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Scroll<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Scroll<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Scroll<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

search

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Search<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Search<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Search<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

searchShards

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: SearchShards
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: SearchShards
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: SearchShards
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

searchTemplate

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: SearchTemplate<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: SearchTemplate<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: SearchTemplate<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

search_shards

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: SearchShards
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: SearchShards
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: SearchShards
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

search_template

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: SearchTemplate<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: SearchTemplate<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: SearchTemplate<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

termvectors

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Termvectors<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Termvectors<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Termvectors<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

update

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: Update<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Update<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: Update<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

updateByQuery

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: UpdateByQuery<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: UpdateByQuery<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: UpdateByQuery<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

updateByQueryRethrottle

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

update_by_query

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • Optional params: UpdateByQuery<TRequestBody>
    • Optional options: TransportRequestOptions

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: UpdateByQuery<TRequestBody>
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TRequestBody extends RequestBody<Record<string, any>> = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • params: UpdateByQuery<TRequestBody>
    • options: TransportRequestOptions
    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

update_by_query_rethrottle

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestPromise<ApiResponse<TResponse, TContext>>

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    • callback: callbackFn<TResponse, TContext>

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

  • Type Parameters

    • TResponse = Record<string, any>

    • TContext = Record<string, unknown>

    Parameters

    Returns TransportRequestCallback

Settings

Member Visibility

Theme

Generated using TypeDoc