diff --git a/api/OpenSearchApi.d.ts b/api/OpenSearchApi.d.ts new file mode 100644 index 000000000..b735dafc8 --- /dev/null +++ b/api/OpenSearchApi.d.ts @@ -0,0 +1,1627 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import * as Global from './_types/_global'; +import * as API from './index'; +import { + ApiError, + ApiResponse, + TransportRequestOptions, + TransportRequestCallback, + TransportRequestPromise, +} from '../lib/Transport'; + +declare type callbackFn = (err: ApiError, result: TResponse) => void; + +declare interface HttpRequest { + path: string; + querystring?: Global.Params; + headers?: Record; + body?: Record | Record[] | string; +} + +export default class OpenSearchAPI { + asynchronousSearch: { + search (params?: API.AsynchronousSearch_Search_Request, options?: TransportRequestOptions): TransportRequestPromise; + search (callback: callbackFn): TransportRequestCallback; + search (params: API.AsynchronousSearch_Search_Request, callback: callbackFn): TransportRequestCallback; + search (params: API.AsynchronousSearch_Search_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + delete (params: API.AsynchronousSearch_Delete_Request, options?: TransportRequestOptions): TransportRequestPromise; + delete (params: API.AsynchronousSearch_Delete_Request, callback: callbackFn): TransportRequestCallback; + delete (params: API.AsynchronousSearch_Delete_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + get (params: API.AsynchronousSearch_Get_Request, options?: TransportRequestOptions): TransportRequestPromise; + get (params: API.AsynchronousSearch_Get_Request, callback: callbackFn): TransportRequestCallback; + get (params: API.AsynchronousSearch_Get_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + stats (params?: API.AsynchronousSearch_Stats_Request, options?: TransportRequestOptions): TransportRequestPromise; + stats (callback: callbackFn): TransportRequestCallback; + stats (params: API.AsynchronousSearch_Stats_Request, callback: callbackFn): TransportRequestCallback; + stats (params: API.AsynchronousSearch_Stats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + cat: { + help (params?: API.Cat_Help_Request, options?: TransportRequestOptions): TransportRequestPromise; + help (callback: callbackFn): TransportRequestCallback; + help (params: API.Cat_Help_Request, callback: callbackFn): TransportRequestCallback; + help (params: API.Cat_Help_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + aliases (params?: API.Cat_Aliases_Request, options?: TransportRequestOptions): TransportRequestPromise; + aliases (callback: callbackFn): TransportRequestCallback; + aliases (params: API.Cat_Aliases_Request, callback: callbackFn): TransportRequestCallback; + aliases (params: API.Cat_Aliases_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + allocation (params?: API.Cat_Allocation_Request, options?: TransportRequestOptions): TransportRequestPromise; + allocation (callback: callbackFn): TransportRequestCallback; + allocation (params: API.Cat_Allocation_Request, callback: callbackFn): TransportRequestCallback; + allocation (params: API.Cat_Allocation_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + clusterManager (params?: API.Cat_ClusterManager_Request, options?: TransportRequestOptions): TransportRequestPromise; + clusterManager (callback: callbackFn): TransportRequestCallback; + clusterManager (params: API.Cat_ClusterManager_Request, callback: callbackFn): TransportRequestCallback; + clusterManager (params: API.Cat_ClusterManager_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + count (params?: API.Cat_Count_Request, options?: TransportRequestOptions): TransportRequestPromise; + count (callback: callbackFn): TransportRequestCallback; + count (params: API.Cat_Count_Request, callback: callbackFn): TransportRequestCallback; + count (params: API.Cat_Count_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + fielddata (params?: API.Cat_Fielddata_Request, options?: TransportRequestOptions): TransportRequestPromise; + fielddata (callback: callbackFn): TransportRequestCallback; + fielddata (params: API.Cat_Fielddata_Request, callback: callbackFn): TransportRequestCallback; + fielddata (params: API.Cat_Fielddata_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + health (params?: API.Cat_Health_Request, options?: TransportRequestOptions): TransportRequestPromise; + health (callback: callbackFn): TransportRequestCallback; + health (params: API.Cat_Health_Request, callback: callbackFn): TransportRequestCallback; + health (params: API.Cat_Health_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + indices (params?: API.Cat_Indices_Request, options?: TransportRequestOptions): TransportRequestPromise; + indices (callback: callbackFn): TransportRequestCallback; + indices (params: API.Cat_Indices_Request, callback: callbackFn): TransportRequestCallback; + indices (params: API.Cat_Indices_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + master (params?: API.Cat_Master_Request, options?: TransportRequestOptions): TransportRequestPromise; + master (callback: callbackFn): TransportRequestCallback; + master (params: API.Cat_Master_Request, callback: callbackFn): TransportRequestCallback; + master (params: API.Cat_Master_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + nodeattrs (params?: API.Cat_Nodeattrs_Request, options?: TransportRequestOptions): TransportRequestPromise; + nodeattrs (callback: callbackFn): TransportRequestCallback; + nodeattrs (params: API.Cat_Nodeattrs_Request, callback: callbackFn): TransportRequestCallback; + nodeattrs (params: API.Cat_Nodeattrs_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + nodes (params?: API.Cat_Nodes_Request, options?: TransportRequestOptions): TransportRequestPromise; + nodes (callback: callbackFn): TransportRequestCallback; + nodes (params: API.Cat_Nodes_Request, callback: callbackFn): TransportRequestCallback; + nodes (params: API.Cat_Nodes_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + pendingTasks (params?: API.Cat_PendingTasks_Request, options?: TransportRequestOptions): TransportRequestPromise; + pendingTasks (callback: callbackFn): TransportRequestCallback; + pendingTasks (params: API.Cat_PendingTasks_Request, callback: callbackFn): TransportRequestCallback; + pendingTasks (params: API.Cat_PendingTasks_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + pitSegments (params?: API.Cat_PitSegments_Request, options?: TransportRequestOptions): TransportRequestPromise; + pitSegments (callback: callbackFn): TransportRequestCallback; + pitSegments (params: API.Cat_PitSegments_Request, callback: callbackFn): TransportRequestCallback; + pitSegments (params: API.Cat_PitSegments_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + allPitSegments (params?: API.Cat_AllPitSegments_Request, options?: TransportRequestOptions): TransportRequestPromise; + allPitSegments (callback: callbackFn): TransportRequestCallback; + allPitSegments (params: API.Cat_AllPitSegments_Request, callback: callbackFn): TransportRequestCallback; + allPitSegments (params: API.Cat_AllPitSegments_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + plugins (params?: API.Cat_Plugins_Request, options?: TransportRequestOptions): TransportRequestPromise; + plugins (callback: callbackFn): TransportRequestCallback; + plugins (params: API.Cat_Plugins_Request, callback: callbackFn): TransportRequestCallback; + plugins (params: API.Cat_Plugins_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + recovery (params?: API.Cat_Recovery_Request, options?: TransportRequestOptions): TransportRequestPromise; + recovery (callback: callbackFn): TransportRequestCallback; + recovery (params: API.Cat_Recovery_Request, callback: callbackFn): TransportRequestCallback; + recovery (params: API.Cat_Recovery_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + repositories (params?: API.Cat_Repositories_Request, options?: TransportRequestOptions): TransportRequestPromise; + repositories (callback: callbackFn): TransportRequestCallback; + repositories (params: API.Cat_Repositories_Request, callback: callbackFn): TransportRequestCallback; + repositories (params: API.Cat_Repositories_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + segmentReplication (params?: API.Cat_SegmentReplication_Request, options?: TransportRequestOptions): TransportRequestPromise; + segmentReplication (callback: callbackFn): TransportRequestCallback; + segmentReplication (params: API.Cat_SegmentReplication_Request, callback: callbackFn): TransportRequestCallback; + segmentReplication (params: API.Cat_SegmentReplication_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + segments (params?: API.Cat_Segments_Request, options?: TransportRequestOptions): TransportRequestPromise; + segments (callback: callbackFn): TransportRequestCallback; + segments (params: API.Cat_Segments_Request, callback: callbackFn): TransportRequestCallback; + segments (params: API.Cat_Segments_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + shards (params?: API.Cat_Shards_Request, options?: TransportRequestOptions): TransportRequestPromise; + shards (callback: callbackFn): TransportRequestCallback; + shards (params: API.Cat_Shards_Request, callback: callbackFn): TransportRequestCallback; + shards (params: API.Cat_Shards_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + snapshots (params?: API.Cat_Snapshots_Request, options?: TransportRequestOptions): TransportRequestPromise; + snapshots (callback: callbackFn): TransportRequestCallback; + snapshots (params: API.Cat_Snapshots_Request, callback: callbackFn): TransportRequestCallback; + snapshots (params: API.Cat_Snapshots_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + tasks (params?: API.Cat_Tasks_Request, options?: TransportRequestOptions): TransportRequestPromise; + tasks (callback: callbackFn): TransportRequestCallback; + tasks (params: API.Cat_Tasks_Request, callback: callbackFn): TransportRequestCallback; + tasks (params: API.Cat_Tasks_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + templates (params?: API.Cat_Templates_Request, options?: TransportRequestOptions): TransportRequestPromise; + templates (callback: callbackFn): TransportRequestCallback; + templates (params: API.Cat_Templates_Request, callback: callbackFn): TransportRequestCallback; + templates (params: API.Cat_Templates_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + threadPool (params?: API.Cat_ThreadPool_Request, options?: TransportRequestOptions): TransportRequestPromise; + threadPool (callback: callbackFn): TransportRequestCallback; + threadPool (params: API.Cat_ThreadPool_Request, callback: callbackFn): TransportRequestCallback; + threadPool (params: API.Cat_ThreadPool_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + cluster: { + allocationExplain (params?: API.Cluster_AllocationExplain_Request, options?: TransportRequestOptions): TransportRequestPromise; + allocationExplain (callback: callbackFn): TransportRequestCallback; + allocationExplain (params: API.Cluster_AllocationExplain_Request, callback: callbackFn): TransportRequestCallback; + allocationExplain (params: API.Cluster_AllocationExplain_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteDecommissionAwareness (params?: API.Cluster_DeleteDecommissionAwareness_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteDecommissionAwareness (callback: callbackFn): TransportRequestCallback; + deleteDecommissionAwareness (params: API.Cluster_DeleteDecommissionAwareness_Request, callback: callbackFn): TransportRequestCallback; + deleteDecommissionAwareness (params: API.Cluster_DeleteDecommissionAwareness_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getDecommissionAwareness (params: API.Cluster_GetDecommissionAwareness_Request, options?: TransportRequestOptions): TransportRequestPromise; + getDecommissionAwareness (params: API.Cluster_GetDecommissionAwareness_Request, callback: callbackFn): TransportRequestCallback; + getDecommissionAwareness (params: API.Cluster_GetDecommissionAwareness_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putDecommissionAwareness (params: API.Cluster_PutDecommissionAwareness_Request, options?: TransportRequestOptions): TransportRequestPromise; + putDecommissionAwareness (params: API.Cluster_PutDecommissionAwareness_Request, callback: callbackFn): TransportRequestCallback; + putDecommissionAwareness (params: API.Cluster_PutDecommissionAwareness_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + health (params?: API.Cluster_Health_Request, options?: TransportRequestOptions): TransportRequestPromise; + health (callback: callbackFn): TransportRequestCallback; + health (params: API.Cluster_Health_Request, callback: callbackFn): TransportRequestCallback; + health (params: API.Cluster_Health_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + pendingTasks (params?: API.Cluster_PendingTasks_Request, options?: TransportRequestOptions): TransportRequestPromise; + pendingTasks (callback: callbackFn): TransportRequestCallback; + pendingTasks (params: API.Cluster_PendingTasks_Request, callback: callbackFn): TransportRequestCallback; + pendingTasks (params: API.Cluster_PendingTasks_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + reroute (params?: API.Cluster_Reroute_Request, options?: TransportRequestOptions): TransportRequestPromise; + reroute (callback: callbackFn): TransportRequestCallback; + reroute (params: API.Cluster_Reroute_Request, callback: callbackFn): TransportRequestCallback; + reroute (params: API.Cluster_Reroute_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getWeightedRouting (params: API.Cluster_GetWeightedRouting_Request, options?: TransportRequestOptions): TransportRequestPromise; + getWeightedRouting (params: API.Cluster_GetWeightedRouting_Request, callback: callbackFn): TransportRequestCallback; + getWeightedRouting (params: API.Cluster_GetWeightedRouting_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putWeightedRouting (params: API.Cluster_PutWeightedRouting_Request, options?: TransportRequestOptions): TransportRequestPromise; + putWeightedRouting (params: API.Cluster_PutWeightedRouting_Request, callback: callbackFn): TransportRequestCallback; + putWeightedRouting (params: API.Cluster_PutWeightedRouting_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteWeightedRouting (params?: API.Cluster_DeleteWeightedRouting_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteWeightedRouting (callback: callbackFn): TransportRequestCallback; + deleteWeightedRouting (params: API.Cluster_DeleteWeightedRouting_Request, callback: callbackFn): TransportRequestCallback; + deleteWeightedRouting (params: API.Cluster_DeleteWeightedRouting_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getSettings (params?: API.Cluster_GetSettings_Request, options?: TransportRequestOptions): TransportRequestPromise; + getSettings (callback: callbackFn): TransportRequestCallback; + getSettings (params: API.Cluster_GetSettings_Request, callback: callbackFn): TransportRequestCallback; + getSettings (params: API.Cluster_GetSettings_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putSettings (params: API.Cluster_PutSettings_Request, options?: TransportRequestOptions): TransportRequestPromise; + putSettings (params: API.Cluster_PutSettings_Request, callback: callbackFn): TransportRequestCallback; + putSettings (params: API.Cluster_PutSettings_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + state (params?: API.Cluster_State_Request, options?: TransportRequestOptions): TransportRequestPromise; + state (callback: callbackFn): TransportRequestCallback; + state (params: API.Cluster_State_Request, callback: callbackFn): TransportRequestCallback; + state (params: API.Cluster_State_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + stats (params?: API.Cluster_Stats_Request, options?: TransportRequestOptions): TransportRequestPromise; + stats (callback: callbackFn): TransportRequestCallback; + stats (params: API.Cluster_Stats_Request, callback: callbackFn): TransportRequestCallback; + stats (params: API.Cluster_Stats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteVotingConfigExclusions (params?: API.Cluster_DeleteVotingConfigExclusions_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteVotingConfigExclusions (callback: callbackFn): TransportRequestCallback; + deleteVotingConfigExclusions (params: API.Cluster_DeleteVotingConfigExclusions_Request, callback: callbackFn): TransportRequestCallback; + deleteVotingConfigExclusions (params: API.Cluster_DeleteVotingConfigExclusions_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + postVotingConfigExclusions (params?: API.Cluster_PostVotingConfigExclusions_Request, options?: TransportRequestOptions): TransportRequestPromise; + postVotingConfigExclusions (callback: callbackFn): TransportRequestCallback; + postVotingConfigExclusions (params: API.Cluster_PostVotingConfigExclusions_Request, callback: callbackFn): TransportRequestCallback; + postVotingConfigExclusions (params: API.Cluster_PostVotingConfigExclusions_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getComponentTemplate (params?: API.Cluster_GetComponentTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + getComponentTemplate (callback: callbackFn): TransportRequestCallback; + getComponentTemplate (params: API.Cluster_GetComponentTemplate_Request, callback: callbackFn): TransportRequestCallback; + getComponentTemplate (params: API.Cluster_GetComponentTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteComponentTemplate (params: API.Cluster_DeleteComponentTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteComponentTemplate (params: API.Cluster_DeleteComponentTemplate_Request, callback: callbackFn): TransportRequestCallback; + deleteComponentTemplate (params: API.Cluster_DeleteComponentTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + existsComponentTemplate (params: API.Cluster_ExistsComponentTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + existsComponentTemplate (params: API.Cluster_ExistsComponentTemplate_Request, callback: callbackFn): TransportRequestCallback; + existsComponentTemplate (params: API.Cluster_ExistsComponentTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putComponentTemplate (params: API.Cluster_PutComponentTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + putComponentTemplate (params: API.Cluster_PutComponentTemplate_Request, callback: callbackFn): TransportRequestCallback; + putComponentTemplate (params: API.Cluster_PutComponentTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + remoteInfo (params?: API.Cluster_RemoteInfo_Request, options?: TransportRequestOptions): TransportRequestPromise; + remoteInfo (callback: callbackFn): TransportRequestCallback; + remoteInfo (params: API.Cluster_RemoteInfo_Request, callback: callbackFn): TransportRequestCallback; + remoteInfo (params: API.Cluster_RemoteInfo_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + danglingIndices: { + listDanglingIndices (params?: API.DanglingIndices_ListDanglingIndices_Request, options?: TransportRequestOptions): TransportRequestPromise; + listDanglingIndices (callback: callbackFn): TransportRequestCallback; + listDanglingIndices (params: API.DanglingIndices_ListDanglingIndices_Request, callback: callbackFn): TransportRequestCallback; + listDanglingIndices (params: API.DanglingIndices_ListDanglingIndices_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteDanglingIndex (params: API.DanglingIndices_DeleteDanglingIndex_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteDanglingIndex (params: API.DanglingIndices_DeleteDanglingIndex_Request, callback: callbackFn): TransportRequestCallback; + deleteDanglingIndex (params: API.DanglingIndices_DeleteDanglingIndex_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + importDanglingIndex (params: API.DanglingIndices_ImportDanglingIndex_Request, options?: TransportRequestOptions): TransportRequestPromise; + importDanglingIndex (params: API.DanglingIndices_ImportDanglingIndex_Request, callback: callbackFn): TransportRequestCallback; + importDanglingIndex (params: API.DanglingIndices_ImportDanglingIndex_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + flowFramework: { + create (params?: API.FlowFramework_Create_Request, options?: TransportRequestOptions): TransportRequestPromise; + create (callback: callbackFn): TransportRequestCallback; + create (params: API.FlowFramework_Create_Request, callback: callbackFn): TransportRequestCallback; + create (params: API.FlowFramework_Create_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + search (params: API.FlowFramework_Search_Request, options?: TransportRequestOptions): TransportRequestPromise; + search (params: API.FlowFramework_Search_Request, callback: callbackFn): TransportRequestCallback; + search (params: API.FlowFramework_Search_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getSteps (params?: API.FlowFramework_GetSteps_Request, options?: TransportRequestOptions): TransportRequestPromise; + getSteps (callback: callbackFn): TransportRequestCallback; + getSteps (params: API.FlowFramework_GetSteps_Request, callback: callbackFn): TransportRequestCallback; + getSteps (params: API.FlowFramework_GetSteps_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + delete (params: API.FlowFramework_Delete_Request, options?: TransportRequestOptions): TransportRequestPromise; + delete (params: API.FlowFramework_Delete_Request, callback: callbackFn): TransportRequestCallback; + delete (params: API.FlowFramework_Delete_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + get (params: API.FlowFramework_Get_Request, options?: TransportRequestOptions): TransportRequestPromise; + get (params: API.FlowFramework_Get_Request, callback: callbackFn): TransportRequestCallback; + get (params: API.FlowFramework_Get_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + update (params: API.FlowFramework_Update_Request, options?: TransportRequestOptions): TransportRequestPromise; + update (params: API.FlowFramework_Update_Request, callback: callbackFn): TransportRequestCallback; + update (params: API.FlowFramework_Update_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deprovision (params: API.FlowFramework_Deprovision_Request, options?: TransportRequestOptions): TransportRequestPromise; + deprovision (params: API.FlowFramework_Deprovision_Request, callback: callbackFn): TransportRequestCallback; + deprovision (params: API.FlowFramework_Deprovision_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + provision (params: API.FlowFramework_Provision_Request, options?: TransportRequestOptions): TransportRequestPromise; + provision (params: API.FlowFramework_Provision_Request, callback: callbackFn): TransportRequestCallback; + provision (params: API.FlowFramework_Provision_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getStatus (params: API.FlowFramework_GetStatus_Request, options?: TransportRequestOptions): TransportRequestPromise; + getStatus (params: API.FlowFramework_GetStatus_Request, callback: callbackFn): TransportRequestCallback; + getStatus (params: API.FlowFramework_GetStatus_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + searchState (params: API.FlowFramework_SearchState_Request, options?: TransportRequestOptions): TransportRequestPromise; + searchState (params: API.FlowFramework_SearchState_Request, callback: callbackFn): TransportRequestCallback; + searchState (params: API.FlowFramework_SearchState_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + indices: { + getAlias (params?: API.Indices_GetAlias_Request, options?: TransportRequestOptions): TransportRequestPromise; + getAlias (callback: callbackFn): TransportRequestCallback; + getAlias (params: API.Indices_GetAlias_Request, callback: callbackFn): TransportRequestCallback; + getAlias (params: API.Indices_GetAlias_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putAlias (params?: API.Indices_PutAlias_Request, options?: TransportRequestOptions): TransportRequestPromise; + putAlias (callback: callbackFn): TransportRequestCallback; + putAlias (params: API.Indices_PutAlias_Request, callback: callbackFn): TransportRequestCallback; + putAlias (params: API.Indices_PutAlias_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + existsAlias (params: API.Indices_ExistsAlias_Request, options?: TransportRequestOptions): TransportRequestPromise; + existsAlias (params: API.Indices_ExistsAlias_Request, callback: callbackFn): TransportRequestCallback; + existsAlias (params: API.Indices_ExistsAlias_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + updateAliases (params: API.Indices_UpdateAliases_Request, options?: TransportRequestOptions): TransportRequestPromise; + updateAliases (params: API.Indices_UpdateAliases_Request, callback: callbackFn): TransportRequestCallback; + updateAliases (params: API.Indices_UpdateAliases_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + analyze (params?: API.Indices_Analyze_Request, options?: TransportRequestOptions): TransportRequestPromise; + analyze (callback: callbackFn): TransportRequestCallback; + analyze (params: API.Indices_Analyze_Request, callback: callbackFn): TransportRequestCallback; + analyze (params: API.Indices_Analyze_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + clearCache (params?: API.Indices_ClearCache_Request, options?: TransportRequestOptions): TransportRequestPromise; + clearCache (callback: callbackFn): TransportRequestCallback; + clearCache (params: API.Indices_ClearCache_Request, callback: callbackFn): TransportRequestCallback; + clearCache (params: API.Indices_ClearCache_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getDataStream (params?: API.Indices_GetDataStream_Request, options?: TransportRequestOptions): TransportRequestPromise; + getDataStream (callback: callbackFn): TransportRequestCallback; + getDataStream (params: API.Indices_GetDataStream_Request, callback: callbackFn): TransportRequestCallback; + getDataStream (params: API.Indices_GetDataStream_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + dataStreamsStats (params?: API.Indices_DataStreamsStats_Request, options?: TransportRequestOptions): TransportRequestPromise; + dataStreamsStats (callback: callbackFn): TransportRequestCallback; + dataStreamsStats (params: API.Indices_DataStreamsStats_Request, callback: callbackFn): TransportRequestCallback; + dataStreamsStats (params: API.Indices_DataStreamsStats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteDataStream (params: API.Indices_DeleteDataStream_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteDataStream (params: API.Indices_DeleteDataStream_Request, callback: callbackFn): TransportRequestCallback; + deleteDataStream (params: API.Indices_DeleteDataStream_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createDataStream (params: API.Indices_CreateDataStream_Request, options?: TransportRequestOptions): TransportRequestPromise; + createDataStream (params: API.Indices_CreateDataStream_Request, callback: callbackFn): TransportRequestCallback; + createDataStream (params: API.Indices_CreateDataStream_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + flush (params?: API.Indices_Flush_Request, options?: TransportRequestOptions): TransportRequestPromise; + flush (callback: callbackFn): TransportRequestCallback; + flush (params: API.Indices_Flush_Request, callback: callbackFn): TransportRequestCallback; + flush (params: API.Indices_Flush_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + forcemerge (params?: API.Indices_Forcemerge_Request, options?: TransportRequestOptions): TransportRequestPromise; + forcemerge (callback: callbackFn): TransportRequestCallback; + forcemerge (params: API.Indices_Forcemerge_Request, callback: callbackFn): TransportRequestCallback; + forcemerge (params: API.Indices_Forcemerge_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getIndexTemplate (params?: API.Indices_GetIndexTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + getIndexTemplate (callback: callbackFn): TransportRequestCallback; + getIndexTemplate (params: API.Indices_GetIndexTemplate_Request, callback: callbackFn): TransportRequestCallback; + getIndexTemplate (params: API.Indices_GetIndexTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + simulateTemplate (params?: API.Indices_SimulateTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + simulateTemplate (callback: callbackFn): TransportRequestCallback; + simulateTemplate (params: API.Indices_SimulateTemplate_Request, callback: callbackFn): TransportRequestCallback; + simulateTemplate (params: API.Indices_SimulateTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + simulateIndexTemplate (params: API.Indices_SimulateIndexTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + simulateIndexTemplate (params: API.Indices_SimulateIndexTemplate_Request, callback: callbackFn): TransportRequestCallback; + simulateIndexTemplate (params: API.Indices_SimulateIndexTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteIndexTemplate (params: API.Indices_DeleteIndexTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteIndexTemplate (params: API.Indices_DeleteIndexTemplate_Request, callback: callbackFn): TransportRequestCallback; + deleteIndexTemplate (params: API.Indices_DeleteIndexTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + existsIndexTemplate (params: API.Indices_ExistsIndexTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + existsIndexTemplate (params: API.Indices_ExistsIndexTemplate_Request, callback: callbackFn): TransportRequestCallback; + existsIndexTemplate (params: API.Indices_ExistsIndexTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putIndexTemplate (params: API.Indices_PutIndexTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + putIndexTemplate (params: API.Indices_PutIndexTemplate_Request, callback: callbackFn): TransportRequestCallback; + putIndexTemplate (params: API.Indices_PutIndexTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getMapping (params?: API.Indices_GetMapping_Request, options?: TransportRequestOptions): TransportRequestPromise; + getMapping (callback: callbackFn): TransportRequestCallback; + getMapping (params: API.Indices_GetMapping_Request, callback: callbackFn): TransportRequestCallback; + getMapping (params: API.Indices_GetMapping_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getFieldMapping (params: API.Indices_GetFieldMapping_Request, options?: TransportRequestOptions): TransportRequestPromise; + getFieldMapping (params: API.Indices_GetFieldMapping_Request, callback: callbackFn): TransportRequestCallback; + getFieldMapping (params: API.Indices_GetFieldMapping_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + recovery (params?: API.Indices_Recovery_Request, options?: TransportRequestOptions): TransportRequestPromise; + recovery (callback: callbackFn): TransportRequestCallback; + recovery (params: API.Indices_Recovery_Request, callback: callbackFn): TransportRequestCallback; + recovery (params: API.Indices_Recovery_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + refresh (params?: API.Indices_Refresh_Request, options?: TransportRequestOptions): TransportRequestPromise; + refresh (callback: callbackFn): TransportRequestCallback; + refresh (params: API.Indices_Refresh_Request, callback: callbackFn): TransportRequestCallback; + refresh (params: API.Indices_Refresh_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + resolveIndex (params: API.Indices_ResolveIndex_Request, options?: TransportRequestOptions): TransportRequestPromise; + resolveIndex (params: API.Indices_ResolveIndex_Request, callback: callbackFn): TransportRequestCallback; + resolveIndex (params: API.Indices_ResolveIndex_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + segments (params?: API.Indices_Segments_Request, options?: TransportRequestOptions): TransportRequestPromise; + segments (callback: callbackFn): TransportRequestCallback; + segments (params: API.Indices_Segments_Request, callback: callbackFn): TransportRequestCallback; + segments (params: API.Indices_Segments_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getSettings (params?: API.Indices_GetSettings_Request, options?: TransportRequestOptions): TransportRequestPromise; + getSettings (callback: callbackFn): TransportRequestCallback; + getSettings (params: API.Indices_GetSettings_Request, callback: callbackFn): TransportRequestCallback; + getSettings (params: API.Indices_GetSettings_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putSettings (params: API.Indices_PutSettings_Request, options?: TransportRequestOptions): TransportRequestPromise; + putSettings (params: API.Indices_PutSettings_Request, callback: callbackFn): TransportRequestCallback; + putSettings (params: API.Indices_PutSettings_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + shardStores (params?: API.Indices_ShardStores_Request, options?: TransportRequestOptions): TransportRequestPromise; + shardStores (callback: callbackFn): TransportRequestCallback; + shardStores (params: API.Indices_ShardStores_Request, callback: callbackFn): TransportRequestCallback; + shardStores (params: API.Indices_ShardStores_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + stats (params?: API.Indices_Stats_Request, options?: TransportRequestOptions): TransportRequestPromise; + stats (callback: callbackFn): TransportRequestCallback; + stats (params: API.Indices_Stats_Request, callback: callbackFn): TransportRequestCallback; + stats (params: API.Indices_Stats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getTemplate (params?: API.Indices_GetTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + getTemplate (callback: callbackFn): TransportRequestCallback; + getTemplate (params: API.Indices_GetTemplate_Request, callback: callbackFn): TransportRequestCallback; + getTemplate (params: API.Indices_GetTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteTemplate (params: API.Indices_DeleteTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteTemplate (params: API.Indices_DeleteTemplate_Request, callback: callbackFn): TransportRequestCallback; + deleteTemplate (params: API.Indices_DeleteTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + existsTemplate (params: API.Indices_ExistsTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + existsTemplate (params: API.Indices_ExistsTemplate_Request, callback: callbackFn): TransportRequestCallback; + existsTemplate (params: API.Indices_ExistsTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putTemplate (params: API.Indices_PutTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + putTemplate (params: API.Indices_PutTemplate_Request, callback: callbackFn): TransportRequestCallback; + putTemplate (params: API.Indices_PutTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getUpgrade (params?: API.Indices_GetUpgrade_Request, options?: TransportRequestOptions): TransportRequestPromise; + getUpgrade (callback: callbackFn): TransportRequestCallback; + getUpgrade (params: API.Indices_GetUpgrade_Request, callback: callbackFn): TransportRequestCallback; + getUpgrade (params: API.Indices_GetUpgrade_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + upgrade (params?: API.Indices_Upgrade_Request, options?: TransportRequestOptions): TransportRequestPromise; + upgrade (callback: callbackFn): TransportRequestCallback; + upgrade (params: API.Indices_Upgrade_Request, callback: callbackFn): TransportRequestCallback; + upgrade (params: API.Indices_Upgrade_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + validateQuery (params?: API.Indices_ValidateQuery_Request, options?: TransportRequestOptions): TransportRequestPromise; + validateQuery (callback: callbackFn): TransportRequestCallback; + validateQuery (params: API.Indices_ValidateQuery_Request, callback: callbackFn): TransportRequestCallback; + validateQuery (params: API.Indices_ValidateQuery_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + rollover (params: API.Indices_Rollover_Request, options?: TransportRequestOptions): TransportRequestPromise; + rollover (params: API.Indices_Rollover_Request, callback: callbackFn): TransportRequestCallback; + rollover (params: API.Indices_Rollover_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + delete (params: API.Indices_Delete_Request, options?: TransportRequestOptions): TransportRequestPromise; + delete (params: API.Indices_Delete_Request, callback: callbackFn): TransportRequestCallback; + delete (params: API.Indices_Delete_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + get (params: API.Indices_Get_Request, options?: TransportRequestOptions): TransportRequestPromise; + get (params: API.Indices_Get_Request, callback: callbackFn): TransportRequestCallback; + get (params: API.Indices_Get_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + exists (params: API.Indices_Exists_Request, options?: TransportRequestOptions): TransportRequestPromise; + exists (params: API.Indices_Exists_Request, callback: callbackFn): TransportRequestCallback; + exists (params: API.Indices_Exists_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + create (params: API.Indices_Create_Request, options?: TransportRequestOptions): TransportRequestPromise; + create (params: API.Indices_Create_Request, callback: callbackFn): TransportRequestCallback; + create (params: API.Indices_Create_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteAlias (params: API.Indices_DeleteAlias_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteAlias (params: API.Indices_DeleteAlias_Request, callback: callbackFn): TransportRequestCallback; + deleteAlias (params: API.Indices_DeleteAlias_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + addBlock (params: API.Indices_AddBlock_Request, options?: TransportRequestOptions): TransportRequestPromise; + addBlock (params: API.Indices_AddBlock_Request, callback: callbackFn): TransportRequestCallback; + addBlock (params: API.Indices_AddBlock_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + clone (params: API.Indices_Clone_Request, options?: TransportRequestOptions): TransportRequestPromise; + clone (params: API.Indices_Clone_Request, callback: callbackFn): TransportRequestCallback; + clone (params: API.Indices_Clone_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + close (params: API.Indices_Close_Request, options?: TransportRequestOptions): TransportRequestPromise; + close (params: API.Indices_Close_Request, callback: callbackFn): TransportRequestCallback; + close (params: API.Indices_Close_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putMapping (params: API.Indices_PutMapping_Request, options?: TransportRequestOptions): TransportRequestPromise; + putMapping (params: API.Indices_PutMapping_Request, callback: callbackFn): TransportRequestCallback; + putMapping (params: API.Indices_PutMapping_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + open (params: API.Indices_Open_Request, options?: TransportRequestOptions): TransportRequestPromise; + open (params: API.Indices_Open_Request, callback: callbackFn): TransportRequestCallback; + open (params: API.Indices_Open_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + shrink (params: API.Indices_Shrink_Request, options?: TransportRequestOptions): TransportRequestPromise; + shrink (params: API.Indices_Shrink_Request, callback: callbackFn): TransportRequestCallback; + shrink (params: API.Indices_Shrink_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + split (params: API.Indices_Split_Request, options?: TransportRequestOptions): TransportRequestPromise; + split (params: API.Indices_Split_Request, callback: callbackFn): TransportRequestCallback; + split (params: API.Indices_Split_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + ingest: { + getPipeline (params?: API.Ingest_GetPipeline_Request, options?: TransportRequestOptions): TransportRequestPromise; + getPipeline (callback: callbackFn): TransportRequestCallback; + getPipeline (params: API.Ingest_GetPipeline_Request, callback: callbackFn): TransportRequestCallback; + getPipeline (params: API.Ingest_GetPipeline_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + simulate (params: API.Ingest_Simulate_Request, options?: TransportRequestOptions): TransportRequestPromise; + simulate (params: API.Ingest_Simulate_Request, callback: callbackFn): TransportRequestCallback; + simulate (params: API.Ingest_Simulate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deletePipeline (params: API.Ingest_DeletePipeline_Request, options?: TransportRequestOptions): TransportRequestPromise; + deletePipeline (params: API.Ingest_DeletePipeline_Request, callback: callbackFn): TransportRequestCallback; + deletePipeline (params: API.Ingest_DeletePipeline_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putPipeline (params: API.Ingest_PutPipeline_Request, options?: TransportRequestOptions): TransportRequestPromise; + putPipeline (params: API.Ingest_PutPipeline_Request, callback: callbackFn): TransportRequestCallback; + putPipeline (params: API.Ingest_PutPipeline_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + processorGrok (params?: API.Ingest_ProcessorGrok_Request, options?: TransportRequestOptions): TransportRequestPromise; + processorGrok (callback: callbackFn): TransportRequestCallback; + processorGrok (params: API.Ingest_ProcessorGrok_Request, callback: callbackFn): TransportRequestCallback; + processorGrok (params: API.Ingest_ProcessorGrok_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + ism: { + addPolicy (params?: API.Ism_AddPolicy_Request, options?: TransportRequestOptions): TransportRequestPromise; + addPolicy (callback: callbackFn): TransportRequestCallback; + addPolicy (params: API.Ism_AddPolicy_Request, callback: callbackFn): TransportRequestCallback; + addPolicy (params: API.Ism_AddPolicy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + changePolicy (params?: API.Ism_ChangePolicy_Request, options?: TransportRequestOptions): TransportRequestPromise; + changePolicy (callback: callbackFn): TransportRequestCallback; + changePolicy (params: API.Ism_ChangePolicy_Request, callback: callbackFn): TransportRequestCallback; + changePolicy (params: API.Ism_ChangePolicy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + explainPolicy (params?: API.Ism_ExplainPolicy_Request, options?: TransportRequestOptions): TransportRequestPromise; + explainPolicy (callback: callbackFn): TransportRequestCallback; + explainPolicy (params: API.Ism_ExplainPolicy_Request, callback: callbackFn): TransportRequestCallback; + explainPolicy (params: API.Ism_ExplainPolicy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getPolicies (params?: API.Ism_GetPolicies_Request, options?: TransportRequestOptions): TransportRequestPromise; + getPolicies (callback: callbackFn): TransportRequestCallback; + getPolicies (params: API.Ism_GetPolicies_Request, callback: callbackFn): TransportRequestCallback; + getPolicies (params: API.Ism_GetPolicies_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putPolicies (params: API.Ism_PutPolicies_Request, options?: TransportRequestOptions): TransportRequestPromise; + putPolicies (params: API.Ism_PutPolicies_Request, callback: callbackFn): TransportRequestCallback; + putPolicies (params: API.Ism_PutPolicies_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deletePolicy (params: API.Ism_DeletePolicy_Request, options?: TransportRequestOptions): TransportRequestPromise; + deletePolicy (params: API.Ism_DeletePolicy_Request, callback: callbackFn): TransportRequestCallback; + deletePolicy (params: API.Ism_DeletePolicy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getPolicy (params: API.Ism_GetPolicy_Request, options?: TransportRequestOptions): TransportRequestPromise; + getPolicy (params: API.Ism_GetPolicy_Request, callback: callbackFn): TransportRequestCallback; + getPolicy (params: API.Ism_GetPolicy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + existsPolicy (params: API.Ism_ExistsPolicy_Request, options?: TransportRequestOptions): TransportRequestPromise; + existsPolicy (params: API.Ism_ExistsPolicy_Request, callback: callbackFn): TransportRequestCallback; + existsPolicy (params: API.Ism_ExistsPolicy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putPolicy (params: API.Ism_PutPolicy_Request, options?: TransportRequestOptions): TransportRequestPromise; + putPolicy (params: API.Ism_PutPolicy_Request, callback: callbackFn): TransportRequestCallback; + putPolicy (params: API.Ism_PutPolicy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + removePolicy (params?: API.Ism_RemovePolicy_Request, options?: TransportRequestOptions): TransportRequestPromise; + removePolicy (callback: callbackFn): TransportRequestCallback; + removePolicy (params: API.Ism_RemovePolicy_Request, callback: callbackFn): TransportRequestCallback; + removePolicy (params: API.Ism_RemovePolicy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + retryIndex (params?: API.Ism_RetryIndex_Request, options?: TransportRequestOptions): TransportRequestPromise; + retryIndex (callback: callbackFn): TransportRequestCallback; + retryIndex (params: API.Ism_RetryIndex_Request, callback: callbackFn): TransportRequestCallback; + retryIndex (params: API.Ism_RetryIndex_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + refreshSearchAnalyzers (params: API.Ism_RefreshSearchAnalyzers_Request, options?: TransportRequestOptions): TransportRequestPromise; + refreshSearchAnalyzers (params: API.Ism_RefreshSearchAnalyzers_Request, callback: callbackFn): TransportRequestCallback; + refreshSearchAnalyzers (params: API.Ism_RefreshSearchAnalyzers_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + knn: { + stats (params?: API.Knn_Stats_Request, options?: TransportRequestOptions): TransportRequestPromise; + stats (callback: callbackFn): TransportRequestCallback; + stats (params: API.Knn_Stats_Request, callback: callbackFn): TransportRequestCallback; + stats (params: API.Knn_Stats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + searchModels (params?: API.Knn_SearchModels_Request, options?: TransportRequestOptions): TransportRequestPromise; + searchModels (callback: callbackFn): TransportRequestCallback; + searchModels (params: API.Knn_SearchModels_Request, callback: callbackFn): TransportRequestCallback; + searchModels (params: API.Knn_SearchModels_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + trainModel (params: API.Knn_TrainModel_Request, options?: TransportRequestOptions): TransportRequestPromise; + trainModel (params: API.Knn_TrainModel_Request, callback: callbackFn): TransportRequestCallback; + trainModel (params: API.Knn_TrainModel_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteModel (params: API.Knn_DeleteModel_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteModel (params: API.Knn_DeleteModel_Request, callback: callbackFn): TransportRequestCallback; + deleteModel (params: API.Knn_DeleteModel_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getModel (params: API.Knn_GetModel_Request, options?: TransportRequestOptions): TransportRequestPromise; + getModel (params: API.Knn_GetModel_Request, callback: callbackFn): TransportRequestCallback; + getModel (params: API.Knn_GetModel_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + warmup (params: API.Knn_Warmup_Request, options?: TransportRequestOptions): TransportRequestPromise; + warmup (params: API.Knn_Warmup_Request, callback: callbackFn): TransportRequestCallback; + warmup (params: API.Knn_Warmup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + ml: { + registerAgents (params?: API.Ml_RegisterAgents_Request, options?: TransportRequestOptions): TransportRequestPromise; + registerAgents (callback: callbackFn): TransportRequestCallback; + registerAgents (params: API.Ml_RegisterAgents_Request, callback: callbackFn): TransportRequestCallback; + registerAgents (params: API.Ml_RegisterAgents_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteAgent (params: API.Ml_DeleteAgent_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteAgent (params: API.Ml_DeleteAgent_Request, callback: callbackFn): TransportRequestCallback; + deleteAgent (params: API.Ml_DeleteAgent_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createConnector (params?: API.Ml_CreateConnector_Request, options?: TransportRequestOptions): TransportRequestPromise; + createConnector (callback: callbackFn): TransportRequestCallback; + createConnector (params: API.Ml_CreateConnector_Request, callback: callbackFn): TransportRequestCallback; + createConnector (params: API.Ml_CreateConnector_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteConnector (params: API.Ml_DeleteConnector_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteConnector (params: API.Ml_DeleteConnector_Request, callback: callbackFn): TransportRequestCallback; + deleteConnector (params: API.Ml_DeleteConnector_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + registerModelGroup (params?: API.Ml_RegisterModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; + registerModelGroup (callback: callbackFn): TransportRequestCallback; + registerModelGroup (params: API.Ml_RegisterModelGroup_Request, callback: callbackFn): TransportRequestCallback; + registerModelGroup (params: API.Ml_RegisterModelGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteModelGroup (params: API.Ml_DeleteModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteModelGroup (params: API.Ml_DeleteModelGroup_Request, callback: callbackFn): TransportRequestCallback; + deleteModelGroup (params: API.Ml_DeleteModelGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getModelGroup (params: API.Ml_GetModelGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; + getModelGroup (params: API.Ml_GetModelGroup_Request, callback: callbackFn): TransportRequestCallback; + getModelGroup (params: API.Ml_GetModelGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + registerModel (params?: API.Ml_RegisterModel_Request, options?: TransportRequestOptions): TransportRequestPromise; + registerModel (callback: callbackFn): TransportRequestCallback; + registerModel (params: API.Ml_RegisterModel_Request, callback: callbackFn): TransportRequestCallback; + registerModel (params: API.Ml_RegisterModel_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + searchModels (params?: API.Ml_SearchModels_Request, options?: TransportRequestOptions): TransportRequestPromise; + searchModels (callback: callbackFn): TransportRequestCallback; + searchModels (params: API.Ml_SearchModels_Request, callback: callbackFn): TransportRequestCallback; + searchModels (params: API.Ml_SearchModels_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteModel (params: API.Ml_DeleteModel_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteModel (params: API.Ml_DeleteModel_Request, callback: callbackFn): TransportRequestCallback; + deleteModel (params: API.Ml_DeleteModel_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deployModel (params: API.Ml_DeployModel_Request, options?: TransportRequestOptions): TransportRequestPromise; + deployModel (params: API.Ml_DeployModel_Request, callback: callbackFn): TransportRequestCallback; + deployModel (params: API.Ml_DeployModel_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + undeployModel (params: API.Ml_UndeployModel_Request, options?: TransportRequestOptions): TransportRequestPromise; + undeployModel (params: API.Ml_UndeployModel_Request, callback: callbackFn): TransportRequestCallback; + undeployModel (params: API.Ml_UndeployModel_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteTask (params: API.Ml_DeleteTask_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteTask (params: API.Ml_DeleteTask_Request, callback: callbackFn): TransportRequestCallback; + deleteTask (params: API.Ml_DeleteTask_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getTask (params: API.Ml_GetTask_Request, options?: TransportRequestOptions): TransportRequestPromise; + getTask (params: API.Ml_GetTask_Request, callback: callbackFn): TransportRequestCallback; + getTask (params: API.Ml_GetTask_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + nodes: { + info (params?: API.Nodes_Info_Request, options?: TransportRequestOptions): TransportRequestPromise; + info (callback: callbackFn): TransportRequestCallback; + info (params: API.Nodes_Info_Request, callback: callbackFn): TransportRequestCallback; + info (params: API.Nodes_Info_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + hotThreads (params?: API.Nodes_HotThreads_Request, options?: TransportRequestOptions): TransportRequestPromise; + hotThreads (callback: callbackFn): TransportRequestCallback; + hotThreads (params: API.Nodes_HotThreads_Request, callback: callbackFn): TransportRequestCallback; + hotThreads (params: API.Nodes_HotThreads_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + reloadSecureSettings (params?: API.Nodes_ReloadSecureSettings_Request, options?: TransportRequestOptions): TransportRequestPromise; + reloadSecureSettings (callback: callbackFn): TransportRequestCallback; + reloadSecureSettings (params: API.Nodes_ReloadSecureSettings_Request, callback: callbackFn): TransportRequestCallback; + reloadSecureSettings (params: API.Nodes_ReloadSecureSettings_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + stats (params?: API.Nodes_Stats_Request, options?: TransportRequestOptions): TransportRequestPromise; + stats (callback: callbackFn): TransportRequestCallback; + stats (params: API.Nodes_Stats_Request, callback: callbackFn): TransportRequestCallback; + stats (params: API.Nodes_Stats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + usage (params?: API.Nodes_Usage_Request, options?: TransportRequestOptions): TransportRequestPromise; + usage (callback: callbackFn): TransportRequestCallback; + usage (params: API.Nodes_Usage_Request, callback: callbackFn): TransportRequestCallback; + usage (params: API.Nodes_Usage_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + notifications: { + listChannels (params?: API.Notifications_ListChannels_Request, options?: TransportRequestOptions): TransportRequestPromise; + listChannels (callback: callbackFn): TransportRequestCallback; + listChannels (params: API.Notifications_ListChannels_Request, callback: callbackFn): TransportRequestCallback; + listChannels (params: API.Notifications_ListChannels_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteConfigs (params: API.Notifications_DeleteConfigs_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteConfigs (params: API.Notifications_DeleteConfigs_Request, callback: callbackFn): TransportRequestCallback; + deleteConfigs (params: API.Notifications_DeleteConfigs_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getConfigs (params?: API.Notifications_GetConfigs_Request, options?: TransportRequestOptions): TransportRequestPromise; + getConfigs (callback: callbackFn): TransportRequestCallback; + getConfigs (params: API.Notifications_GetConfigs_Request, callback: callbackFn): TransportRequestCallback; + getConfigs (params: API.Notifications_GetConfigs_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createConfig (params: API.Notifications_CreateConfig_Request, options?: TransportRequestOptions): TransportRequestPromise; + createConfig (params: API.Notifications_CreateConfig_Request, callback: callbackFn): TransportRequestCallback; + createConfig (params: API.Notifications_CreateConfig_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteConfig (params: API.Notifications_DeleteConfig_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteConfig (params: API.Notifications_DeleteConfig_Request, callback: callbackFn): TransportRequestCallback; + deleteConfig (params: API.Notifications_DeleteConfig_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getConfig (params: API.Notifications_GetConfig_Request, options?: TransportRequestOptions): TransportRequestPromise; + getConfig (params: API.Notifications_GetConfig_Request, callback: callbackFn): TransportRequestCallback; + getConfig (params: API.Notifications_GetConfig_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + updateConfig (params: API.Notifications_UpdateConfig_Request, options?: TransportRequestOptions): TransportRequestPromise; + updateConfig (params: API.Notifications_UpdateConfig_Request, callback: callbackFn): TransportRequestCallback; + updateConfig (params: API.Notifications_UpdateConfig_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + sendTest (params: API.Notifications_SendTest_Request, options?: TransportRequestOptions): TransportRequestPromise; + sendTest (params: API.Notifications_SendTest_Request, callback: callbackFn): TransportRequestCallback; + sendTest (params: API.Notifications_SendTest_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + listFeatures (params?: API.Notifications_ListFeatures_Request, options?: TransportRequestOptions): TransportRequestPromise; + listFeatures (callback: callbackFn): TransportRequestCallback; + listFeatures (params: API.Notifications_ListFeatures_Request, callback: callbackFn): TransportRequestCallback; + listFeatures (params: API.Notifications_ListFeatures_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + observability: { + getLocalstats (params?: API.Observability_GetLocalstats_Request, options?: TransportRequestOptions): TransportRequestPromise; + getLocalstats (callback: callbackFn): TransportRequestCallback; + getLocalstats (params: API.Observability_GetLocalstats_Request, callback: callbackFn): TransportRequestCallback; + getLocalstats (params: API.Observability_GetLocalstats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteObjects (params?: API.Observability_DeleteObjects_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteObjects (callback: callbackFn): TransportRequestCallback; + deleteObjects (params: API.Observability_DeleteObjects_Request, callback: callbackFn): TransportRequestCallback; + deleteObjects (params: API.Observability_DeleteObjects_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + listObjects (params?: API.Observability_ListObjects_Request, options?: TransportRequestOptions): TransportRequestPromise; + listObjects (callback: callbackFn): TransportRequestCallback; + listObjects (params: API.Observability_ListObjects_Request, callback: callbackFn): TransportRequestCallback; + listObjects (params: API.Observability_ListObjects_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createObject (params?: API.Observability_CreateObject_Request, options?: TransportRequestOptions): TransportRequestPromise; + createObject (callback: callbackFn): TransportRequestCallback; + createObject (params: API.Observability_CreateObject_Request, callback: callbackFn): TransportRequestCallback; + createObject (params: API.Observability_CreateObject_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteObject (params: API.Observability_DeleteObject_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteObject (params: API.Observability_DeleteObject_Request, callback: callbackFn): TransportRequestCallback; + deleteObject (params: API.Observability_DeleteObject_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getObject (params: API.Observability_GetObject_Request, options?: TransportRequestOptions): TransportRequestPromise; + getObject (params: API.Observability_GetObject_Request, callback: callbackFn): TransportRequestCallback; + getObject (params: API.Observability_GetObject_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + updateObject (params: API.Observability_UpdateObject_Request, options?: TransportRequestOptions): TransportRequestPromise; + updateObject (params: API.Observability_UpdateObject_Request, callback: callbackFn): TransportRequestCallback; + updateObject (params: API.Observability_UpdateObject_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + ppl: { + query (params: API.Ppl_Query_Request, options?: TransportRequestOptions): TransportRequestPromise; + query (params: API.Ppl_Query_Request, callback: callbackFn): TransportRequestCallback; + query (params: API.Ppl_Query_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + explain (params: API.Ppl_Explain_Request, options?: TransportRequestOptions): TransportRequestPromise; + explain (params: API.Ppl_Explain_Request, callback: callbackFn): TransportRequestCallback; + explain (params: API.Ppl_Explain_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getStats (params?: API.Ppl_GetStats_Request, options?: TransportRequestOptions): TransportRequestPromise; + getStats (callback: callbackFn): TransportRequestCallback; + getStats (params: API.Ppl_GetStats_Request, callback: callbackFn): TransportRequestCallback; + getStats (params: API.Ppl_GetStats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + postStats (params: API.Ppl_PostStats_Request, options?: TransportRequestOptions): TransportRequestPromise; + postStats (params: API.Ppl_PostStats_Request, callback: callbackFn): TransportRequestCallback; + postStats (params: API.Ppl_PostStats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + query: { + datasourcesList (params?: API.Query_DatasourcesList_Request, options?: TransportRequestOptions): TransportRequestPromise; + datasourcesList (callback: callbackFn): TransportRequestCallback; + datasourcesList (params: API.Query_DatasourcesList_Request, callback: callbackFn): TransportRequestCallback; + datasourcesList (params: API.Query_DatasourcesList_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + datasourcesCreate (params?: API.Query_DatasourcesCreate_Request, options?: TransportRequestOptions): TransportRequestPromise; + datasourcesCreate (callback: callbackFn): TransportRequestCallback; + datasourcesCreate (params: API.Query_DatasourcesCreate_Request, callback: callbackFn): TransportRequestCallback; + datasourcesCreate (params: API.Query_DatasourcesCreate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + datasourcesUpdate (params?: API.Query_DatasourcesUpdate_Request, options?: TransportRequestOptions): TransportRequestPromise; + datasourcesUpdate (callback: callbackFn): TransportRequestCallback; + datasourcesUpdate (params: API.Query_DatasourcesUpdate_Request, callback: callbackFn): TransportRequestCallback; + datasourcesUpdate (params: API.Query_DatasourcesUpdate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + datasourceDelete (params: API.Query_DatasourceDelete_Request, options?: TransportRequestOptions): TransportRequestPromise; + datasourceDelete (params: API.Query_DatasourceDelete_Request, callback: callbackFn): TransportRequestCallback; + datasourceDelete (params: API.Query_DatasourceDelete_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + datasourceRetrieve (params: API.Query_DatasourceRetrieve_Request, options?: TransportRequestOptions): TransportRequestPromise; + datasourceRetrieve (params: API.Query_DatasourceRetrieve_Request, callback: callbackFn): TransportRequestCallback; + datasourceRetrieve (params: API.Query_DatasourceRetrieve_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + remoteStore: { + restore (params: API.RemoteStore_Restore_Request, options?: TransportRequestOptions): TransportRequestPromise; + restore (params: API.RemoteStore_Restore_Request, callback: callbackFn): TransportRequestCallback; + restore (params: API.RemoteStore_Restore_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + rollups: { + delete (params: API.Rollups_Delete_Request, options?: TransportRequestOptions): TransportRequestPromise; + delete (params: API.Rollups_Delete_Request, callback: callbackFn): TransportRequestCallback; + delete (params: API.Rollups_Delete_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + get (params: API.Rollups_Get_Request, options?: TransportRequestOptions): TransportRequestPromise; + get (params: API.Rollups_Get_Request, callback: callbackFn): TransportRequestCallback; + get (params: API.Rollups_Get_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + put (params: API.Rollups_Put_Request, options?: TransportRequestOptions): TransportRequestPromise; + put (params: API.Rollups_Put_Request, callback: callbackFn): TransportRequestCallback; + put (params: API.Rollups_Put_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + explain (params: API.Rollups_Explain_Request, options?: TransportRequestOptions): TransportRequestPromise; + explain (params: API.Rollups_Explain_Request, callback: callbackFn): TransportRequestCallback; + explain (params: API.Rollups_Explain_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + start (params: API.Rollups_Start_Request, options?: TransportRequestOptions): TransportRequestPromise; + start (params: API.Rollups_Start_Request, callback: callbackFn): TransportRequestCallback; + start (params: API.Rollups_Start_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + stop (params: API.Rollups_Stop_Request, options?: TransportRequestOptions): TransportRequestPromise; + stop (params: API.Rollups_Stop_Request, callback: callbackFn): TransportRequestCallback; + stop (params: API.Rollups_Stop_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + searchPipeline: { + get (params?: API.SearchPipeline_Get_Request, options?: TransportRequestOptions): TransportRequestPromise; + get (callback: callbackFn): TransportRequestCallback; + get (params: API.SearchPipeline_Get_Request, callback: callbackFn): TransportRequestCallback; + get (params: API.SearchPipeline_Get_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + delete (params: API.SearchPipeline_Delete_Request, options?: TransportRequestOptions): TransportRequestPromise; + delete (params: API.SearchPipeline_Delete_Request, callback: callbackFn): TransportRequestCallback; + delete (params: API.SearchPipeline_Delete_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + put (params: API.SearchPipeline_Put_Request, options?: TransportRequestOptions): TransportRequestPromise; + put (params: API.SearchPipeline_Put_Request, callback: callbackFn): TransportRequestCallback; + put (params: API.SearchPipeline_Put_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + security: { + getSslinfo (params?: API.Security_GetSslinfo_Request, options?: TransportRequestOptions): TransportRequestPromise; + getSslinfo (callback: callbackFn): TransportRequestCallback; + getSslinfo (params: API.Security_GetSslinfo_Request, callback: callbackFn): TransportRequestCallback; + getSslinfo (params: API.Security_GetSslinfo_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + configUpgradeCheck (params?: API.Security_ConfigUpgradeCheck_Request, options?: TransportRequestOptions): TransportRequestPromise; + configUpgradeCheck (callback: callbackFn): TransportRequestCallback; + configUpgradeCheck (params: API.Security_ConfigUpgradeCheck_Request, callback: callbackFn): TransportRequestCallback; + configUpgradeCheck (params: API.Security_ConfigUpgradeCheck_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + configUpgradePerform (params?: API.Security_ConfigUpgradePerform_Request, options?: TransportRequestOptions): TransportRequestPromise; + configUpgradePerform (callback: callbackFn): TransportRequestCallback; + configUpgradePerform (params: API.Security_ConfigUpgradePerform_Request, callback: callbackFn): TransportRequestCallback; + configUpgradePerform (params: API.Security_ConfigUpgradePerform_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getAccountDetails (params?: API.Security_GetAccountDetails_Request, options?: TransportRequestOptions): TransportRequestPromise; + getAccountDetails (callback: callbackFn): TransportRequestCallback; + getAccountDetails (params: API.Security_GetAccountDetails_Request, callback: callbackFn): TransportRequestCallback; + getAccountDetails (params: API.Security_GetAccountDetails_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + changePassword (params: API.Security_ChangePassword_Request, options?: TransportRequestOptions): TransportRequestPromise; + changePassword (params: API.Security_ChangePassword_Request, callback: callbackFn): TransportRequestCallback; + changePassword (params: API.Security_ChangePassword_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getActionGroups (params?: API.Security_GetActionGroups_Request, options?: TransportRequestOptions): TransportRequestPromise; + getActionGroups (callback: callbackFn): TransportRequestCallback; + getActionGroups (params: API.Security_GetActionGroups_Request, callback: callbackFn): TransportRequestCallback; + getActionGroups (params: API.Security_GetActionGroups_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchActionGroups (params: API.Security_PatchActionGroups_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchActionGroups (params: API.Security_PatchActionGroups_Request, callback: callbackFn): TransportRequestCallback; + patchActionGroups (params: API.Security_PatchActionGroups_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteActionGroup (params: API.Security_DeleteActionGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteActionGroup (params: API.Security_DeleteActionGroup_Request, callback: callbackFn): TransportRequestCallback; + deleteActionGroup (params: API.Security_DeleteActionGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getActionGroup (params: API.Security_GetActionGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; + getActionGroup (params: API.Security_GetActionGroup_Request, callback: callbackFn): TransportRequestCallback; + getActionGroup (params: API.Security_GetActionGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchActionGroup (params: API.Security_PatchActionGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchActionGroup (params: API.Security_PatchActionGroup_Request, callback: callbackFn): TransportRequestCallback; + patchActionGroup (params: API.Security_PatchActionGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createActionGroup (params: API.Security_CreateActionGroup_Request, options?: TransportRequestOptions): TransportRequestPromise; + createActionGroup (params: API.Security_CreateActionGroup_Request, callback: callbackFn): TransportRequestCallback; + createActionGroup (params: API.Security_CreateActionGroup_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getAllowlist (params?: API.Security_GetAllowlist_Request, options?: TransportRequestOptions): TransportRequestPromise; + getAllowlist (callback: callbackFn): TransportRequestCallback; + getAllowlist (params: API.Security_GetAllowlist_Request, callback: callbackFn): TransportRequestCallback; + getAllowlist (params: API.Security_GetAllowlist_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchAllowlist (params: API.Security_PatchAllowlist_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchAllowlist (params: API.Security_PatchAllowlist_Request, callback: callbackFn): TransportRequestCallback; + patchAllowlist (params: API.Security_PatchAllowlist_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createAllowlist (params: API.Security_CreateAllowlist_Request, options?: TransportRequestOptions): TransportRequestPromise; + createAllowlist (params: API.Security_CreateAllowlist_Request, callback: callbackFn): TransportRequestCallback; + createAllowlist (params: API.Security_CreateAllowlist_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getAuditConfiguration (params?: API.Security_GetAuditConfiguration_Request, options?: TransportRequestOptions): TransportRequestPromise; + getAuditConfiguration (callback: callbackFn): TransportRequestCallback; + getAuditConfiguration (params: API.Security_GetAuditConfiguration_Request, callback: callbackFn): TransportRequestCallback; + getAuditConfiguration (params: API.Security_GetAuditConfiguration_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchAuditConfiguration (params: API.Security_PatchAuditConfiguration_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchAuditConfiguration (params: API.Security_PatchAuditConfiguration_Request, callback: callbackFn): TransportRequestCallback; + patchAuditConfiguration (params: API.Security_PatchAuditConfiguration_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + updateAuditConfiguration (params: API.Security_UpdateAuditConfiguration_Request, options?: TransportRequestOptions): TransportRequestPromise; + updateAuditConfiguration (params: API.Security_UpdateAuditConfiguration_Request, callback: callbackFn): TransportRequestCallback; + updateAuditConfiguration (params: API.Security_UpdateAuditConfiguration_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + authtoken (params?: API.Security_Authtoken_Request, options?: TransportRequestOptions): TransportRequestPromise; + authtoken (callback: callbackFn): TransportRequestCallback; + authtoken (params: API.Security_Authtoken_Request, callback: callbackFn): TransportRequestCallback; + authtoken (params: API.Security_Authtoken_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + flushCache (params?: API.Security_FlushCache_Request, options?: TransportRequestOptions): TransportRequestPromise; + flushCache (callback: callbackFn): TransportRequestCallback; + flushCache (params: API.Security_FlushCache_Request, callback: callbackFn): TransportRequestCallback; + flushCache (params: API.Security_FlushCache_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getAllCertificates (params?: API.Security_GetAllCertificates_Request, options?: TransportRequestOptions): TransportRequestPromise; + getAllCertificates (callback: callbackFn): TransportRequestCallback; + getAllCertificates (params: API.Security_GetAllCertificates_Request, callback: callbackFn): TransportRequestCallback; + getAllCertificates (params: API.Security_GetAllCertificates_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getNodeCertificates (params: API.Security_GetNodeCertificates_Request, options?: TransportRequestOptions): TransportRequestPromise; + getNodeCertificates (params: API.Security_GetNodeCertificates_Request, callback: callbackFn): TransportRequestCallback; + getNodeCertificates (params: API.Security_GetNodeCertificates_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + generateOboToken (params: API.Security_GenerateOboToken_Request, options?: TransportRequestOptions): TransportRequestPromise; + generateOboToken (params: API.Security_GenerateOboToken_Request, callback: callbackFn): TransportRequestCallback; + generateOboToken (params: API.Security_GenerateOboToken_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getUsers (params?: API.Security_GetUsers_Request, options?: TransportRequestOptions): TransportRequestPromise; + getUsers (callback: callbackFn): TransportRequestCallback; + getUsers (params: API.Security_GetUsers_Request, callback: callbackFn): TransportRequestCallback; + getUsers (params: API.Security_GetUsers_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchUsers (params: API.Security_PatchUsers_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchUsers (params: API.Security_PatchUsers_Request, callback: callbackFn): TransportRequestCallback; + patchUsers (params: API.Security_PatchUsers_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteUser (params: API.Security_DeleteUser_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteUser (params: API.Security_DeleteUser_Request, callback: callbackFn): TransportRequestCallback; + deleteUser (params: API.Security_DeleteUser_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getUser (params: API.Security_GetUser_Request, options?: TransportRequestOptions): TransportRequestPromise; + getUser (params: API.Security_GetUser_Request, callback: callbackFn): TransportRequestCallback; + getUser (params: API.Security_GetUser_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchUser (params: API.Security_PatchUser_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchUser (params: API.Security_PatchUser_Request, callback: callbackFn): TransportRequestCallback; + patchUser (params: API.Security_PatchUser_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createUser (params: API.Security_CreateUser_Request, options?: TransportRequestOptions): TransportRequestPromise; + createUser (params: API.Security_CreateUser_Request, callback: callbackFn): TransportRequestCallback; + createUser (params: API.Security_CreateUser_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + generateUserToken (params: API.Security_GenerateUserToken_Request, options?: TransportRequestOptions): TransportRequestPromise; + generateUserToken (params: API.Security_GenerateUserToken_Request, callback: callbackFn): TransportRequestCallback; + generateUserToken (params: API.Security_GenerateUserToken_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + migrate (params?: API.Security_Migrate_Request, options?: TransportRequestOptions): TransportRequestPromise; + migrate (callback: callbackFn): TransportRequestCallback; + migrate (params: API.Security_Migrate_Request, callback: callbackFn): TransportRequestCallback; + migrate (params: API.Security_Migrate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getDistinguishedNames (params?: API.Security_GetDistinguishedNames_Request, options?: TransportRequestOptions): TransportRequestPromise; + getDistinguishedNames (callback: callbackFn): TransportRequestCallback; + getDistinguishedNames (params: API.Security_GetDistinguishedNames_Request, callback: callbackFn): TransportRequestCallback; + getDistinguishedNames (params: API.Security_GetDistinguishedNames_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchDistinguishedNames (params: API.Security_PatchDistinguishedNames_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchDistinguishedNames (params: API.Security_PatchDistinguishedNames_Request, callback: callbackFn): TransportRequestCallback; + patchDistinguishedNames (params: API.Security_PatchDistinguishedNames_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteDistinguishedName (params: API.Security_DeleteDistinguishedName_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteDistinguishedName (params: API.Security_DeleteDistinguishedName_Request, callback: callbackFn): TransportRequestCallback; + deleteDistinguishedName (params: API.Security_DeleteDistinguishedName_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getDistinguishedName (params: API.Security_GetDistinguishedName_Request, options?: TransportRequestOptions): TransportRequestPromise; + getDistinguishedName (params: API.Security_GetDistinguishedName_Request, callback: callbackFn): TransportRequestCallback; + getDistinguishedName (params: API.Security_GetDistinguishedName_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchDistinguishedName (params: API.Security_PatchDistinguishedName_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchDistinguishedName (params: API.Security_PatchDistinguishedName_Request, callback: callbackFn): TransportRequestCallback; + patchDistinguishedName (params: API.Security_PatchDistinguishedName_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + updateDistinguishedName (params: API.Security_UpdateDistinguishedName_Request, options?: TransportRequestOptions): TransportRequestPromise; + updateDistinguishedName (params: API.Security_UpdateDistinguishedName_Request, callback: callbackFn): TransportRequestCallback; + updateDistinguishedName (params: API.Security_UpdateDistinguishedName_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getPermissionsInfo (params?: API.Security_GetPermissionsInfo_Request, options?: TransportRequestOptions): TransportRequestPromise; + getPermissionsInfo (callback: callbackFn): TransportRequestCallback; + getPermissionsInfo (params: API.Security_GetPermissionsInfo_Request, callback: callbackFn): TransportRequestCallback; + getPermissionsInfo (params: API.Security_GetPermissionsInfo_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getRoles (params?: API.Security_GetRoles_Request, options?: TransportRequestOptions): TransportRequestPromise; + getRoles (callback: callbackFn): TransportRequestCallback; + getRoles (params: API.Security_GetRoles_Request, callback: callbackFn): TransportRequestCallback; + getRoles (params: API.Security_GetRoles_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchRoles (params: API.Security_PatchRoles_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchRoles (params: API.Security_PatchRoles_Request, callback: callbackFn): TransportRequestCallback; + patchRoles (params: API.Security_PatchRoles_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteRole (params: API.Security_DeleteRole_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteRole (params: API.Security_DeleteRole_Request, callback: callbackFn): TransportRequestCallback; + deleteRole (params: API.Security_DeleteRole_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getRole (params: API.Security_GetRole_Request, options?: TransportRequestOptions): TransportRequestPromise; + getRole (params: API.Security_GetRole_Request, callback: callbackFn): TransportRequestCallback; + getRole (params: API.Security_GetRole_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchRole (params: API.Security_PatchRole_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchRole (params: API.Security_PatchRole_Request, callback: callbackFn): TransportRequestCallback; + patchRole (params: API.Security_PatchRole_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createRole (params: API.Security_CreateRole_Request, options?: TransportRequestOptions): TransportRequestPromise; + createRole (params: API.Security_CreateRole_Request, callback: callbackFn): TransportRequestCallback; + createRole (params: API.Security_CreateRole_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getRoleMappings (params?: API.Security_GetRoleMappings_Request, options?: TransportRequestOptions): TransportRequestPromise; + getRoleMappings (callback: callbackFn): TransportRequestCallback; + getRoleMappings (params: API.Security_GetRoleMappings_Request, callback: callbackFn): TransportRequestCallback; + getRoleMappings (params: API.Security_GetRoleMappings_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchRoleMappings (params: API.Security_PatchRoleMappings_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchRoleMappings (params: API.Security_PatchRoleMappings_Request, callback: callbackFn): TransportRequestCallback; + patchRoleMappings (params: API.Security_PatchRoleMappings_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteRoleMapping (params: API.Security_DeleteRoleMapping_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteRoleMapping (params: API.Security_DeleteRoleMapping_Request, callback: callbackFn): TransportRequestCallback; + deleteRoleMapping (params: API.Security_DeleteRoleMapping_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getRoleMapping (params: API.Security_GetRoleMapping_Request, options?: TransportRequestOptions): TransportRequestPromise; + getRoleMapping (params: API.Security_GetRoleMapping_Request, callback: callbackFn): TransportRequestCallback; + getRoleMapping (params: API.Security_GetRoleMapping_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchRoleMapping (params: API.Security_PatchRoleMapping_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchRoleMapping (params: API.Security_PatchRoleMapping_Request, callback: callbackFn): TransportRequestCallback; + patchRoleMapping (params: API.Security_PatchRoleMapping_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createRoleMapping (params: API.Security_CreateRoleMapping_Request, options?: TransportRequestOptions): TransportRequestPromise; + createRoleMapping (params: API.Security_CreateRoleMapping_Request, callback: callbackFn): TransportRequestCallback; + createRoleMapping (params: API.Security_CreateRoleMapping_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getConfiguration (params?: API.Security_GetConfiguration_Request, options?: TransportRequestOptions): TransportRequestPromise; + getConfiguration (callback: callbackFn): TransportRequestCallback; + getConfiguration (params: API.Security_GetConfiguration_Request, callback: callbackFn): TransportRequestCallback; + getConfiguration (params: API.Security_GetConfiguration_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchConfiguration (params: API.Security_PatchConfiguration_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchConfiguration (params: API.Security_PatchConfiguration_Request, callback: callbackFn): TransportRequestCallback; + patchConfiguration (params: API.Security_PatchConfiguration_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + updateConfiguration (params: API.Security_UpdateConfiguration_Request, options?: TransportRequestOptions): TransportRequestPromise; + updateConfiguration (params: API.Security_UpdateConfiguration_Request, callback: callbackFn): TransportRequestCallback; + updateConfiguration (params: API.Security_UpdateConfiguration_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getCertificates (params?: API.Security_GetCertificates_Request, options?: TransportRequestOptions): TransportRequestPromise; + getCertificates (callback: callbackFn): TransportRequestCallback; + getCertificates (params: API.Security_GetCertificates_Request, callback: callbackFn): TransportRequestCallback; + getCertificates (params: API.Security_GetCertificates_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + reloadHttpCertificates (params?: API.Security_ReloadHttpCertificates_Request, options?: TransportRequestOptions): TransportRequestPromise; + reloadHttpCertificates (callback: callbackFn): TransportRequestCallback; + reloadHttpCertificates (params: API.Security_ReloadHttpCertificates_Request, callback: callbackFn): TransportRequestCallback; + reloadHttpCertificates (params: API.Security_ReloadHttpCertificates_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + reloadTransportCertificates (params?: API.Security_ReloadTransportCertificates_Request, options?: TransportRequestOptions): TransportRequestPromise; + reloadTransportCertificates (callback: callbackFn): TransportRequestCallback; + reloadTransportCertificates (params: API.Security_ReloadTransportCertificates_Request, callback: callbackFn): TransportRequestCallback; + reloadTransportCertificates (params: API.Security_ReloadTransportCertificates_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getTenancyConfig (params?: API.Security_GetTenancyConfig_Request, options?: TransportRequestOptions): TransportRequestPromise; + getTenancyConfig (callback: callbackFn): TransportRequestCallback; + getTenancyConfig (params: API.Security_GetTenancyConfig_Request, callback: callbackFn): TransportRequestCallback; + getTenancyConfig (params: API.Security_GetTenancyConfig_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createUpdateTenancyConfig (params: API.Security_CreateUpdateTenancyConfig_Request, options?: TransportRequestOptions): TransportRequestPromise; + createUpdateTenancyConfig (params: API.Security_CreateUpdateTenancyConfig_Request, callback: callbackFn): TransportRequestCallback; + createUpdateTenancyConfig (params: API.Security_CreateUpdateTenancyConfig_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getTenants (params?: API.Security_GetTenants_Request, options?: TransportRequestOptions): TransportRequestPromise; + getTenants (callback: callbackFn): TransportRequestCallback; + getTenants (params: API.Security_GetTenants_Request, callback: callbackFn): TransportRequestCallback; + getTenants (params: API.Security_GetTenants_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchTenants (params: API.Security_PatchTenants_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchTenants (params: API.Security_PatchTenants_Request, callback: callbackFn): TransportRequestCallback; + patchTenants (params: API.Security_PatchTenants_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteTenant (params: API.Security_DeleteTenant_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteTenant (params: API.Security_DeleteTenant_Request, callback: callbackFn): TransportRequestCallback; + deleteTenant (params: API.Security_DeleteTenant_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getTenant (params: API.Security_GetTenant_Request, options?: TransportRequestOptions): TransportRequestPromise; + getTenant (params: API.Security_GetTenant_Request, callback: callbackFn): TransportRequestCallback; + getTenant (params: API.Security_GetTenant_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patchTenant (params: API.Security_PatchTenant_Request, options?: TransportRequestOptions): TransportRequestPromise; + patchTenant (params: API.Security_PatchTenant_Request, callback: callbackFn): TransportRequestCallback; + patchTenant (params: API.Security_PatchTenant_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createTenant (params: API.Security_CreateTenant_Request, options?: TransportRequestOptions): TransportRequestPromise; + createTenant (params: API.Security_CreateTenant_Request, callback: callbackFn): TransportRequestCallback; + createTenant (params: API.Security_CreateTenant_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getUsersLegacy (params?: API.Security_GetUsersLegacy_Request, options?: TransportRequestOptions): TransportRequestPromise; + getUsersLegacy (callback: callbackFn): TransportRequestCallback; + getUsersLegacy (params: API.Security_GetUsersLegacy_Request, callback: callbackFn): TransportRequestCallback; + getUsersLegacy (params: API.Security_GetUsersLegacy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteUserLegacy (params: API.Security_DeleteUserLegacy_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteUserLegacy (params: API.Security_DeleteUserLegacy_Request, callback: callbackFn): TransportRequestCallback; + deleteUserLegacy (params: API.Security_DeleteUserLegacy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getUserLegacy (params: API.Security_GetUserLegacy_Request, options?: TransportRequestOptions): TransportRequestPromise; + getUserLegacy (params: API.Security_GetUserLegacy_Request, callback: callbackFn): TransportRequestCallback; + getUserLegacy (params: API.Security_GetUserLegacy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createUserLegacy (params: API.Security_CreateUserLegacy_Request, options?: TransportRequestOptions): TransportRequestPromise; + createUserLegacy (params: API.Security_CreateUserLegacy_Request, callback: callbackFn): TransportRequestCallback; + createUserLegacy (params: API.Security_CreateUserLegacy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + generateUserTokenLegacy (params: API.Security_GenerateUserTokenLegacy_Request, options?: TransportRequestOptions): TransportRequestPromise; + generateUserTokenLegacy (params: API.Security_GenerateUserTokenLegacy_Request, callback: callbackFn): TransportRequestCallback; + generateUserTokenLegacy (params: API.Security_GenerateUserTokenLegacy_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + validate (params?: API.Security_Validate_Request, options?: TransportRequestOptions): TransportRequestPromise; + validate (callback: callbackFn): TransportRequestCallback; + validate (params: API.Security_Validate_Request, callback: callbackFn): TransportRequestCallback; + validate (params: API.Security_Validate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + authinfo (params?: API.Security_Authinfo_Request, options?: TransportRequestOptions): TransportRequestPromise; + authinfo (callback: callbackFn): TransportRequestCallback; + authinfo (params: API.Security_Authinfo_Request, callback: callbackFn): TransportRequestCallback; + authinfo (params: API.Security_Authinfo_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getDashboardsInfo (params?: API.Security_GetDashboardsInfo_Request, options?: TransportRequestOptions): TransportRequestPromise; + getDashboardsInfo (callback: callbackFn): TransportRequestCallback; + getDashboardsInfo (params: API.Security_GetDashboardsInfo_Request, callback: callbackFn): TransportRequestCallback; + getDashboardsInfo (params: API.Security_GetDashboardsInfo_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + postDashboardsInfo (params?: API.Security_PostDashboardsInfo_Request, options?: TransportRequestOptions): TransportRequestPromise; + postDashboardsInfo (callback: callbackFn): TransportRequestCallback; + postDashboardsInfo (params: API.Security_PostDashboardsInfo_Request, callback: callbackFn): TransportRequestCallback; + postDashboardsInfo (params: API.Security_PostDashboardsInfo_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + health (params?: API.Security_Health_Request, options?: TransportRequestOptions): TransportRequestPromise; + health (callback: callbackFn): TransportRequestCallback; + health (params: API.Security_Health_Request, callback: callbackFn): TransportRequestCallback; + health (params: API.Security_Health_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + tenantInfo (params?: API.Security_TenantInfo_Request, options?: TransportRequestOptions): TransportRequestPromise; + tenantInfo (callback: callbackFn): TransportRequestCallback; + tenantInfo (params: API.Security_TenantInfo_Request, callback: callbackFn): TransportRequestCallback; + tenantInfo (params: API.Security_TenantInfo_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + whoAmI (params?: API.Security_WhoAmI_Request, options?: TransportRequestOptions): TransportRequestPromise; + whoAmI (callback: callbackFn): TransportRequestCallback; + whoAmI (params: API.Security_WhoAmI_Request, callback: callbackFn): TransportRequestCallback; + whoAmI (params: API.Security_WhoAmI_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + whoAmIProtected (params?: API.Security_WhoAmIProtected_Request, options?: TransportRequestOptions): TransportRequestPromise; + whoAmIProtected (callback: callbackFn): TransportRequestCallback; + whoAmIProtected (params: API.Security_WhoAmIProtected_Request, callback: callbackFn): TransportRequestCallback; + whoAmIProtected (params: API.Security_WhoAmIProtected_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + snapshot: { + getRepository (params?: API.Snapshot_GetRepository_Request, options?: TransportRequestOptions): TransportRequestPromise; + getRepository (callback: callbackFn): TransportRequestCallback; + getRepository (params: API.Snapshot_GetRepository_Request, callback: callbackFn): TransportRequestCallback; + getRepository (params: API.Snapshot_GetRepository_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + status (params?: API.Snapshot_Status_Request, options?: TransportRequestOptions): TransportRequestPromise; + status (callback: callbackFn): TransportRequestCallback; + status (params: API.Snapshot_Status_Request, callback: callbackFn): TransportRequestCallback; + status (params: API.Snapshot_Status_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteRepository (params: API.Snapshot_DeleteRepository_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteRepository (params: API.Snapshot_DeleteRepository_Request, callback: callbackFn): TransportRequestCallback; + deleteRepository (params: API.Snapshot_DeleteRepository_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createRepository (params: API.Snapshot_CreateRepository_Request, options?: TransportRequestOptions): TransportRequestPromise; + createRepository (params: API.Snapshot_CreateRepository_Request, callback: callbackFn): TransportRequestCallback; + createRepository (params: API.Snapshot_CreateRepository_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + cleanupRepository (params: API.Snapshot_CleanupRepository_Request, options?: TransportRequestOptions): TransportRequestPromise; + cleanupRepository (params: API.Snapshot_CleanupRepository_Request, callback: callbackFn): TransportRequestCallback; + cleanupRepository (params: API.Snapshot_CleanupRepository_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + verifyRepository (params: API.Snapshot_VerifyRepository_Request, options?: TransportRequestOptions): TransportRequestPromise; + verifyRepository (params: API.Snapshot_VerifyRepository_Request, callback: callbackFn): TransportRequestCallback; + verifyRepository (params: API.Snapshot_VerifyRepository_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + delete (params: API.Snapshot_Delete_Request, options?: TransportRequestOptions): TransportRequestPromise; + delete (params: API.Snapshot_Delete_Request, callback: callbackFn): TransportRequestCallback; + delete (params: API.Snapshot_Delete_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + get (params: API.Snapshot_Get_Request, options?: TransportRequestOptions): TransportRequestPromise; + get (params: API.Snapshot_Get_Request, callback: callbackFn): TransportRequestCallback; + get (params: API.Snapshot_Get_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + create (params: API.Snapshot_Create_Request, options?: TransportRequestOptions): TransportRequestPromise; + create (params: API.Snapshot_Create_Request, callback: callbackFn): TransportRequestCallback; + create (params: API.Snapshot_Create_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + clone (params: API.Snapshot_Clone_Request, options?: TransportRequestOptions): TransportRequestPromise; + clone (params: API.Snapshot_Clone_Request, callback: callbackFn): TransportRequestCallback; + clone (params: API.Snapshot_Clone_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + restore (params: API.Snapshot_Restore_Request, options?: TransportRequestOptions): TransportRequestPromise; + restore (params: API.Snapshot_Restore_Request, callback: callbackFn): TransportRequestCallback; + restore (params: API.Snapshot_Restore_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + sql: { + settings (params: API.Sql_Settings_Request, options?: TransportRequestOptions): TransportRequestPromise; + settings (params: API.Sql_Settings_Request, callback: callbackFn): TransportRequestCallback; + settings (params: API.Sql_Settings_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + query (params: API.Sql_Query_Request, options?: TransportRequestOptions): TransportRequestPromise; + query (params: API.Sql_Query_Request, callback: callbackFn): TransportRequestCallback; + query (params: API.Sql_Query_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + explain (params: API.Sql_Explain_Request, options?: TransportRequestOptions): TransportRequestPromise; + explain (params: API.Sql_Explain_Request, callback: callbackFn): TransportRequestCallback; + explain (params: API.Sql_Explain_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + close (params: API.Sql_Close_Request, options?: TransportRequestOptions): TransportRequestPromise; + close (params: API.Sql_Close_Request, callback: callbackFn): TransportRequestCallback; + close (params: API.Sql_Close_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getStats (params?: API.Sql_GetStats_Request, options?: TransportRequestOptions): TransportRequestPromise; + getStats (callback: callbackFn): TransportRequestCallback; + getStats (params: API.Sql_GetStats_Request, callback: callbackFn): TransportRequestCallback; + getStats (params: API.Sql_GetStats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + postStats (params: API.Sql_PostStats_Request, options?: TransportRequestOptions): TransportRequestPromise; + postStats (params: API.Sql_PostStats_Request, callback: callbackFn): TransportRequestCallback; + postStats (params: API.Sql_PostStats_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + tasks: { + list (params?: API.Tasks_List_Request, options?: TransportRequestOptions): TransportRequestPromise; + list (callback: callbackFn): TransportRequestCallback; + list (params: API.Tasks_List_Request, callback: callbackFn): TransportRequestCallback; + list (params: API.Tasks_List_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + cancel (params?: API.Tasks_Cancel_Request, options?: TransportRequestOptions): TransportRequestPromise; + cancel (callback: callbackFn): TransportRequestCallback; + cancel (params: API.Tasks_Cancel_Request, callback: callbackFn): TransportRequestCallback; + cancel (params: API.Tasks_Cancel_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + get (params: API.Tasks_Get_Request, options?: TransportRequestOptions): TransportRequestPromise; + get (params: API.Tasks_Get_Request, callback: callbackFn): TransportRequestCallback; + get (params: API.Tasks_Get_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + transforms: { + search (params?: API.Transforms_Search_Request, options?: TransportRequestOptions): TransportRequestPromise; + search (callback: callbackFn): TransportRequestCallback; + search (params: API.Transforms_Search_Request, callback: callbackFn): TransportRequestCallback; + search (params: API.Transforms_Search_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + preview (params?: API.Transforms_Preview_Request, options?: TransportRequestOptions): TransportRequestPromise; + preview (callback: callbackFn): TransportRequestCallback; + preview (params: API.Transforms_Preview_Request, callback: callbackFn): TransportRequestCallback; + preview (params: API.Transforms_Preview_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + delete (params: API.Transforms_Delete_Request, options?: TransportRequestOptions): TransportRequestPromise; + delete (params: API.Transforms_Delete_Request, callback: callbackFn): TransportRequestCallback; + delete (params: API.Transforms_Delete_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + get (params: API.Transforms_Get_Request, options?: TransportRequestOptions): TransportRequestPromise; + get (params: API.Transforms_Get_Request, callback: callbackFn): TransportRequestCallback; + get (params: API.Transforms_Get_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + put (params: API.Transforms_Put_Request, options?: TransportRequestOptions): TransportRequestPromise; + put (params: API.Transforms_Put_Request, callback: callbackFn): TransportRequestCallback; + put (params: API.Transforms_Put_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + explain (params: API.Transforms_Explain_Request, options?: TransportRequestOptions): TransportRequestPromise; + explain (params: API.Transforms_Explain_Request, callback: callbackFn): TransportRequestCallback; + explain (params: API.Transforms_Explain_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + start (params: API.Transforms_Start_Request, options?: TransportRequestOptions): TransportRequestPromise; + start (params: API.Transforms_Start_Request, callback: callbackFn): TransportRequestCallback; + start (params: API.Transforms_Start_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + stop (params: API.Transforms_Stop_Request, options?: TransportRequestOptions): TransportRequestPromise; + stop (params: API.Transforms_Stop_Request, callback: callbackFn): TransportRequestCallback; + stop (params: API.Transforms_Stop_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + + http: { + connect (params: HttpRequest, options?: TransportRequestOptions): TransportRequestPromise; + connect (params: HttpRequest, callback: callbackFn): TransportRequestCallback; + connect (params: HttpRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + delete (params: HttpRequest, options?: TransportRequestOptions): TransportRequestPromise; + delete (params: HttpRequest, callback: callbackFn): TransportRequestCallback; + delete (params: HttpRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + get (params: HttpRequest, options?: TransportRequestOptions): TransportRequestPromise; + get (params: HttpRequest, callback: callbackFn): TransportRequestCallback; + get (params: HttpRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + head (params: HttpRequest, options?: TransportRequestOptions): TransportRequestPromise; + head (params: HttpRequest, callback: callbackFn): TransportRequestCallback; + head (params: HttpRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + options (params: HttpRequest, options?: TransportRequestOptions): TransportRequestPromise; + options (params: HttpRequest, callback: callbackFn): TransportRequestCallback; + options (params: HttpRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + patch (params: HttpRequest, options?: TransportRequestOptions): TransportRequestPromise; + patch (params: HttpRequest, callback: callbackFn): TransportRequestCallback; + patch (params: HttpRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + post (params: HttpRequest, options?: TransportRequestOptions): TransportRequestPromise; + post (params: HttpRequest, callback: callbackFn): TransportRequestCallback; + post (params: HttpRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + put (params: HttpRequest, options?: TransportRequestOptions): TransportRequestPromise; + put (params: HttpRequest, callback: callbackFn): TransportRequestCallback; + put (params: HttpRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + trace (params: HttpRequest, options?: TransportRequestOptions): TransportRequestPromise; + trace (params: HttpRequest, callback: callbackFn): TransportRequestCallback; + trace (params: HttpRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + }; + + info (params?: API.Info_Request, options?: TransportRequestOptions): TransportRequestPromise; + info (callback: callbackFn): TransportRequestCallback; + info (params: API.Info_Request, callback: callbackFn): TransportRequestCallback; + info (params: API.Info_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + ping (params?: API.Ping_Request, options?: TransportRequestOptions): TransportRequestPromise; + ping (callback: callbackFn): TransportRequestCallback; + ping (params: API.Ping_Request, callback: callbackFn): TransportRequestCallback; + ping (params: API.Ping_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + bulk (params: API.Bulk_Request, options?: TransportRequestOptions): TransportRequestPromise; + bulk (params: API.Bulk_Request, callback: callbackFn): TransportRequestCallback; + bulk (params: API.Bulk_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + count (params?: API.Count_Request, options?: TransportRequestOptions): TransportRequestPromise; + count (callback: callbackFn): TransportRequestCallback; + count (params: API.Count_Request, callback: callbackFn): TransportRequestCallback; + count (params: API.Count_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteByQueryRethrottle (params: API.DeleteByQueryRethrottle_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteByQueryRethrottle (params: API.DeleteByQueryRethrottle_Request, callback: callbackFn): TransportRequestCallback; + deleteByQueryRethrottle (params: API.DeleteByQueryRethrottle_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + fieldCaps (params?: API.FieldCaps_Request, options?: TransportRequestOptions): TransportRequestPromise; + fieldCaps (callback: callbackFn): TransportRequestCallback; + fieldCaps (params: API.FieldCaps_Request, callback: callbackFn): TransportRequestCallback; + fieldCaps (params: API.FieldCaps_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + mget (params: API.Mget_Request, options?: TransportRequestOptions): TransportRequestPromise; + mget (params: API.Mget_Request, callback: callbackFn): TransportRequestCallback; + mget (params: API.Mget_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + msearch (params: API.Msearch_Request, options?: TransportRequestOptions): TransportRequestPromise; + msearch (params: API.Msearch_Request, callback: callbackFn): TransportRequestCallback; + msearch (params: API.Msearch_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + msearchTemplate (params: API.MsearchTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + msearchTemplate (params: API.MsearchTemplate_Request, callback: callbackFn): TransportRequestCallback; + msearchTemplate (params: API.MsearchTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + mtermvectors (params?: API.Mtermvectors_Request, options?: TransportRequestOptions): TransportRequestPromise; + mtermvectors (callback: callbackFn): TransportRequestCallback; + mtermvectors (params: API.Mtermvectors_Request, callback: callbackFn): TransportRequestCallback; + mtermvectors (params: API.Mtermvectors_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + rankEval (params: API.RankEval_Request, options?: TransportRequestOptions): TransportRequestPromise; + rankEval (params: API.RankEval_Request, callback: callbackFn): TransportRequestCallback; + rankEval (params: API.RankEval_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + reindex (params: API.Reindex_Request, options?: TransportRequestOptions): TransportRequestPromise; + reindex (params: API.Reindex_Request, callback: callbackFn): TransportRequestCallback; + reindex (params: API.Reindex_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + reindexRethrottle (params: API.ReindexRethrottle_Request, options?: TransportRequestOptions): TransportRequestPromise; + reindexRethrottle (params: API.ReindexRethrottle_Request, callback: callbackFn): TransportRequestCallback; + reindexRethrottle (params: API.ReindexRethrottle_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + renderSearchTemplate (params?: API.RenderSearchTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + renderSearchTemplate (callback: callbackFn): TransportRequestCallback; + renderSearchTemplate (params: API.RenderSearchTemplate_Request, callback: callbackFn): TransportRequestCallback; + renderSearchTemplate (params: API.RenderSearchTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getScriptContext (params?: API.GetScriptContext_Request, options?: TransportRequestOptions): TransportRequestPromise; + getScriptContext (callback: callbackFn): TransportRequestCallback; + getScriptContext (params: API.GetScriptContext_Request, callback: callbackFn): TransportRequestCallback; + getScriptContext (params: API.GetScriptContext_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getScriptLanguages (params?: API.GetScriptLanguages_Request, options?: TransportRequestOptions): TransportRequestPromise; + getScriptLanguages (callback: callbackFn): TransportRequestCallback; + getScriptLanguages (params: API.GetScriptLanguages_Request, callback: callbackFn): TransportRequestCallback; + getScriptLanguages (params: API.GetScriptLanguages_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteScript (params: API.DeleteScript_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteScript (params: API.DeleteScript_Request, callback: callbackFn): TransportRequestCallback; + deleteScript (params: API.DeleteScript_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getScript (params: API.GetScript_Request, options?: TransportRequestOptions): TransportRequestPromise; + getScript (params: API.GetScript_Request, callback: callbackFn): TransportRequestCallback; + getScript (params: API.GetScript_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + putScript (params: API.PutScript_Request, options?: TransportRequestOptions): TransportRequestPromise; + putScript (params: API.PutScript_Request, callback: callbackFn): TransportRequestCallback; + putScript (params: API.PutScript_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + scriptsPainlessExecute (params?: API.ScriptsPainlessExecute_Request, options?: TransportRequestOptions): TransportRequestPromise; + scriptsPainlessExecute (callback: callbackFn): TransportRequestCallback; + scriptsPainlessExecute (params: API.ScriptsPainlessExecute_Request, callback: callbackFn): TransportRequestCallback; + scriptsPainlessExecute (params: API.ScriptsPainlessExecute_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + search (params?: API.Search_Request, options?: TransportRequestOptions): TransportRequestPromise; + search (callback: callbackFn): TransportRequestCallback; + search (params: API.Search_Request, callback: callbackFn): TransportRequestCallback; + search (params: API.Search_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + searchShards (params?: API.SearchShards_Request, options?: TransportRequestOptions): TransportRequestPromise; + searchShards (callback: callbackFn): TransportRequestCallback; + searchShards (params: API.SearchShards_Request, callback: callbackFn): TransportRequestCallback; + searchShards (params: API.SearchShards_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deletePit (params?: API.DeletePit_Request, options?: TransportRequestOptions): TransportRequestPromise; + deletePit (callback: callbackFn): TransportRequestCallback; + deletePit (params: API.DeletePit_Request, callback: callbackFn): TransportRequestCallback; + deletePit (params: API.DeletePit_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteAllPits (params?: API.DeleteAllPits_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteAllPits (callback: callbackFn): TransportRequestCallback; + deleteAllPits (params: API.DeleteAllPits_Request, callback: callbackFn): TransportRequestCallback; + deleteAllPits (params: API.DeleteAllPits_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getAllPits (params?: API.GetAllPits_Request, options?: TransportRequestOptions): TransportRequestPromise; + getAllPits (callback: callbackFn): TransportRequestCallback; + getAllPits (params: API.GetAllPits_Request, callback: callbackFn): TransportRequestCallback; + getAllPits (params: API.GetAllPits_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + clearScroll (params?: API.ClearScroll_Request, options?: TransportRequestOptions): TransportRequestPromise; + clearScroll (callback: callbackFn): TransportRequestCallback; + clearScroll (params: API.ClearScroll_Request, callback: callbackFn): TransportRequestCallback; + clearScroll (params: API.ClearScroll_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + scroll (params?: API.Scroll_Request, options?: TransportRequestOptions): TransportRequestPromise; + scroll (callback: callbackFn): TransportRequestCallback; + scroll (params: API.Scroll_Request, callback: callbackFn): TransportRequestCallback; + scroll (params: API.Scroll_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + searchTemplate (params: API.SearchTemplate_Request, options?: TransportRequestOptions): TransportRequestPromise; + searchTemplate (params: API.SearchTemplate_Request, callback: callbackFn): TransportRequestCallback; + searchTemplate (params: API.SearchTemplate_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + updateByQueryRethrottle (params: API.UpdateByQueryRethrottle_Request, options?: TransportRequestOptions): TransportRequestPromise; + updateByQueryRethrottle (params: API.UpdateByQueryRethrottle_Request, callback: callbackFn): TransportRequestCallback; + updateByQueryRethrottle (params: API.UpdateByQueryRethrottle_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + create (params: API.Create_Request, options?: TransportRequestOptions): TransportRequestPromise; + create (params: API.Create_Request, callback: callbackFn): TransportRequestCallback; + create (params: API.Create_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + deleteByQuery (params: API.DeleteByQuery_Request, options?: TransportRequestOptions): TransportRequestPromise; + deleteByQuery (params: API.DeleteByQuery_Request, callback: callbackFn): TransportRequestCallback; + deleteByQuery (params: API.DeleteByQuery_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + index (params: API.Index_Request, options?: TransportRequestOptions): TransportRequestPromise; + index (params: API.Index_Request, callback: callbackFn): TransportRequestCallback; + index (params: API.Index_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + delete (params: API.Delete_Request, options?: TransportRequestOptions): TransportRequestPromise; + delete (params: API.Delete_Request, callback: callbackFn): TransportRequestCallback; + delete (params: API.Delete_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + get (params: API.Get_Request, options?: TransportRequestOptions): TransportRequestPromise; + get (params: API.Get_Request, callback: callbackFn): TransportRequestCallback; + get (params: API.Get_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + exists (params: API.Exists_Request, options?: TransportRequestOptions): TransportRequestPromise; + exists (params: API.Exists_Request, callback: callbackFn): TransportRequestCallback; + exists (params: API.Exists_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + explain (params: API.Explain_Request, options?: TransportRequestOptions): TransportRequestPromise; + explain (params: API.Explain_Request, callback: callbackFn): TransportRequestCallback; + explain (params: API.Explain_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + createPit (params: API.CreatePit_Request, options?: TransportRequestOptions): TransportRequestPromise; + createPit (params: API.CreatePit_Request, callback: callbackFn): TransportRequestCallback; + createPit (params: API.CreatePit_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + getSource (params: API.GetSource_Request, options?: TransportRequestOptions): TransportRequestPromise; + getSource (params: API.GetSource_Request, callback: callbackFn): TransportRequestCallback; + getSource (params: API.GetSource_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + existsSource (params: API.ExistsSource_Request, options?: TransportRequestOptions): TransportRequestPromise; + existsSource (params: API.ExistsSource_Request, callback: callbackFn): TransportRequestCallback; + existsSource (params: API.ExistsSource_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + termvectors (params: API.Termvectors_Request, options?: TransportRequestOptions): TransportRequestPromise; + termvectors (params: API.Termvectors_Request, callback: callbackFn): TransportRequestCallback; + termvectors (params: API.Termvectors_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + updateByQuery (params: API.UpdateByQuery_Request, options?: TransportRequestOptions): TransportRequestPromise; + updateByQuery (params: API.UpdateByQuery_Request, callback: callbackFn): TransportRequestCallback; + updateByQuery (params: API.UpdateByQuery_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + + update (params: API.Update_Request, options?: TransportRequestOptions): TransportRequestPromise; + update (params: API.Update_Request, callback: callbackFn): TransportRequestCallback; + update (params: API.Update_Request, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback; + +} \ No newline at end of file diff --git a/api/OpenSearchApi.js b/api/OpenSearchApi.js new file mode 100644 index 000000000..272ddbbbf --- /dev/null +++ b/api/OpenSearchApi.js @@ -0,0 +1,187 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { kConfigErr } = require('./utils') +const kApiModules = Symbol('api modules') + +class OpenSearchAPI { + constructor (opts) { + this[kConfigErr] = opts.ConfigurationError + this[kApiModules] = { + asynchronousSearch: new(require('./asynchronousSearch/_api'))(this), + cat: new(require('./cat/_api'))(this), + cluster: new(require('./cluster/_api'))(this), + danglingIndices: new(require('./danglingIndices/_api'))(this), + flowFramework: new(require('./flowFramework/_api'))(this), + http: new(require('./http/_api'))(this), + indices: new(require('./indices/_api'))(this), + ingest: new(require('./ingest/_api'))(this), + ism: new(require('./ism/_api'))(this), + knn: new(require('./knn/_api'))(this), + ml: new(require('./ml/_api'))(this), + nodes: new(require('./nodes/_api'))(this), + notifications: new(require('./notifications/_api'))(this), + observability: new(require('./observability/_api'))(this), + ppl: new(require('./ppl/_api'))(this), + query: new(require('./query/_api'))(this), + remoteStore: new(require('./remoteStore/_api'))(this), + rollups: new(require('./rollups/_api'))(this), + searchPipeline: new(require('./searchPipeline/_api'))(this), + security: new(require('./security/_api'))(this), + snapshot: new(require('./snapshot/_api'))(this), + sql: new(require('./sql/_api'))(this), + tasks: new(require('./tasks/_api'))(this), + transforms: new(require('./transforms/_api'))(this), + } + + // Setup Root API Functions + /** @namespace API-Core */ + this.bulk = require('./_core/bulk').bind(this) + this.clearScroll = require('./_core/clearScroll').bind(this) + this.count = require('./_core/count').bind(this) + this.create = require('./_core/create').bind(this) + this.createPit = require('./_core/createPit').bind(this) + this.delete = require('./_core/delete').bind(this) + this.deleteAllPits = require('./_core/deleteAllPits').bind(this) + this.deleteByQuery = require('./_core/deleteByQuery').bind(this) + this.deleteByQueryRethrottle = require('./_core/deleteByQueryRethrottle').bind(this) + this.deletePit = require('./_core/deletePit').bind(this) + this.deleteScript = require('./_core/deleteScript').bind(this) + this.exists = require('./_core/exists').bind(this) + this.existsSource = require('./_core/existsSource').bind(this) + this.explain = require('./_core/explain').bind(this) + this.fieldCaps = require('./_core/fieldCaps').bind(this) + this.get = require('./_core/get').bind(this) + this.getAllPits = require('./_core/getAllPits').bind(this) + this.getScript = require('./_core/getScript').bind(this) + this.getScriptContext = require('./_core/getScriptContext').bind(this) + this.getScriptLanguages = require('./_core/getScriptLanguages').bind(this) + this.getSource = require('./_core/getSource').bind(this) + this.index = require('./_core/index').bind(this) + this.info = require('./_core/info').bind(this) + this.mget = require('./_core/mget').bind(this) + this.msearch = require('./_core/msearch').bind(this) + this.msearchTemplate = require('./_core/msearchTemplate').bind(this) + this.mtermvectors = require('./_core/mtermvectors').bind(this) + this.ping = require('./_core/ping').bind(this) + this.putScript = require('./_core/putScript').bind(this) + this.rankEval = require('./_core/rankEval').bind(this) + this.reindex = require('./_core/reindex').bind(this) + this.reindexRethrottle = require('./_core/reindexRethrottle').bind(this) + this.renderSearchTemplate = require('./_core/renderSearchTemplate').bind(this) + this.scriptsPainlessExecute = require('./_core/scriptsPainlessExecute').bind(this) + this.scroll = require('./_core/scroll').bind(this) + this.search = require('./_core/search').bind(this) + this.searchShards = require('./_core/searchShards').bind(this) + this.searchTemplate = require('./_core/searchTemplate').bind(this) + this.termvectors = require('./_core/termvectors').bind(this) + this.update = require('./_core/update').bind(this) + this.updateByQuery = require('./_core/updateByQuery').bind(this) + this.updateByQueryRethrottle = require('./_core/updateByQueryRethrottle').bind(this) + + // Deprecated: Use clearScroll instead. + this.clear_scroll = require('./_core/clearScroll').bind(this) + // Deprecated: Use createPit instead. + this.create_pit = require('./_core/createPit').bind(this) + // Deprecated: Use deleteAllPits instead. + this.delete_all_pits = require('./_core/deleteAllPits').bind(this) + // Deprecated: Use deleteByQuery instead. + this.delete_by_query = require('./_core/deleteByQuery').bind(this) + // Deprecated: Use deleteByQueryRethrottle instead. + this.delete_by_query_rethrottle = require('./_core/deleteByQueryRethrottle').bind(this) + // Deprecated: Use deletePit instead. + this.delete_pit = require('./_core/deletePit').bind(this) + // Deprecated: Use deleteScript instead. + this.delete_script = require('./_core/deleteScript').bind(this) + // Deprecated: Use existsSource instead. + this.exists_source = require('./_core/existsSource').bind(this) + // Deprecated: Use fieldCaps instead. + this.field_caps = require('./_core/fieldCaps').bind(this) + // Deprecated: Use getAllPits instead. + this.get_all_pits = require('./_core/getAllPits').bind(this) + // Deprecated: Use getScript instead. + this.get_script = require('./_core/getScript').bind(this) + // Deprecated: Use getScriptContext instead. + this.get_script_context = require('./_core/getScriptContext').bind(this) + // Deprecated: Use getScriptLanguages instead. + this.get_script_languages = require('./_core/getScriptLanguages').bind(this) + // Deprecated: Use getSource instead. + this.get_source = require('./_core/getSource').bind(this) + // Deprecated: Use msearchTemplate instead. + this.msearch_template = require('./_core/msearchTemplate').bind(this) + // Deprecated: Use putScript instead. + this.put_script = require('./_core/putScript').bind(this) + // Deprecated: Use rankEval instead. + this.rank_eval = require('./_core/rankEval').bind(this) + // Deprecated: Use reindexRethrottle instead. + this.reindex_rethrottle = require('./_core/reindexRethrottle').bind(this) + // Deprecated: Use renderSearchTemplate instead. + this.render_search_template = require('./_core/renderSearchTemplate').bind(this) + // Deprecated: Use scriptsPainlessExecute instead. + this.scripts_painless_execute = require('./_core/scriptsPainlessExecute').bind(this) + // Deprecated: Use searchShards instead. + this.search_shards = require('./_core/searchShards').bind(this) + // Deprecated: Use searchTemplate instead. + this.search_template = require('./_core/searchTemplate').bind(this) + // Deprecated: Use updateByQuery instead. + this.update_by_query = require('./_core/updateByQuery').bind(this) + // Deprecated: Use updateByQueryRethrottle instead. + this.update_by_query_rethrottle = require('./_core/updateByQueryRethrottle').bind(this) + + // Setup API Modules + Object.defineProperties(this, { + asynchronousSearch: { get() { return this[kApiModules].asynchronousSearch } }, + cat: { get() { return this[kApiModules].cat } }, + cluster: { get() { return this[kApiModules].cluster } }, + danglingIndices: { get() { return this[kApiModules].danglingIndices } }, + flowFramework: { get() { return this[kApiModules].flowFramework } }, + http: { get() { return this[kApiModules].http } }, + indices: { get() { return this[kApiModules].indices } }, + ingest: { get() { return this[kApiModules].ingest } }, + ism: { get() { return this[kApiModules].ism } }, + knn: { get() { return this[kApiModules].knn } }, + ml: { get() { return this[kApiModules].ml } }, + nodes: { get() { return this[kApiModules].nodes } }, + notifications: { get() { return this[kApiModules].notifications } }, + observability: { get() { return this[kApiModules].observability } }, + ppl: { get() { return this[kApiModules].ppl } }, + query: { get() { return this[kApiModules].query } }, + remoteStore: { get() { return this[kApiModules].remoteStore } }, + rollups: { get() { return this[kApiModules].rollups } }, + searchPipeline: { get() { return this[kApiModules].searchPipeline } }, + security: { get() { return this[kApiModules].security } }, + snapshot: { get() { return this[kApiModules].snapshot } }, + sql: { get() { return this[kApiModules].sql } }, + tasks: { get() { return this[kApiModules].tasks } }, + transforms: { get() { return this[kApiModules].transforms } }, + + // Deprecated: Use asynchronousSearch instead. + asynchronous_search: { get() { return this[kApiModules].asynchronousSearch } }, + // Deprecated: Use danglingIndices instead. + dangling_indices: { get() { return this[kApiModules].danglingIndices } }, + // Deprecated: Use flowFramework instead. + flow_framework: { get() { return this[kApiModules].flowFramework } }, + // Deprecated: Use remoteStore instead. + remote_store: { get() { return this[kApiModules].remoteStore } }, + // Deprecated: Use searchPipeline instead. + search_pipeline: { get() { return this[kApiModules].searchPipeline } }, + }) + } +} + +module.exports = OpenSearchAPI; diff --git a/api/_core/createPit.d.ts b/api/_core/createPit.d.ts index 7dee1a66f..e663a24cd 100644 --- a/api/_core/createPit.d.ts +++ b/api/_core/createPit.d.ts @@ -25,7 +25,7 @@ export interface CreatePit_Request extends Global.Params { index: string[]; keep_alive?: Common.Duration; preference?: string; - routing?: string[]; + routing?: Common.Routing; } export interface CreatePit_Response extends ApiResponse { diff --git a/api/_core/createPit.js b/api/_core/createPit.js index dc671c0bc..9a827f3a1 100644 --- a/api/_core/createPit.js +++ b/api/_core/createPit.js @@ -29,7 +29,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. * @param {string} [params.keep_alive] - Specify the keep alive for point in time. * @param {string} [params.preference=random] - Specify the node or shard the operation should be performed on. - * @param {array} [params.routing] - Comma-separated list of specific routing values. + * @param {string} [params.routing] - Comma-separated list of specific routing values. * @param {array} params.index - Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_core/deleteByQuery.d.ts b/api/_core/deleteByQuery.d.ts index 42ab27676..978f7ef26 100644 --- a/api/_core/deleteByQuery.d.ts +++ b/api/_core/deleteByQuery.d.ts @@ -67,22 +67,7 @@ export interface DeleteByQuery_Response extends ApiResponse { body: DeleteByQuery_ResponseBody; } -export interface DeleteByQuery_ResponseBody { - batches?: number; - deleted?: number; - failures?: Common.BulkIndexByScrollFailure[]; - noops?: number; - requests_per_second?: number; - retries?: Common.Retries; - slice_id?: number; +export type DeleteByQuery_ResponseBody = Common.BulkByScrollResponseBase | { task?: Common.TaskId; - throttled?: Common.Duration; - throttled_millis?: Common.DurationValueUnitMillis; - throttled_until?: Common.Duration; - throttled_until_millis?: Common.DurationValueUnitMillis; - timed_out?: boolean; - took?: Common.DurationValueUnitMillis; - total?: number; - version_conflicts?: number; } diff --git a/api/_core/putScript.js b/api/_core/putScript.js index d637baa04..86e81a67d 100644 --- a/api/_core/putScript.js +++ b/api/_core/putScript.js @@ -26,10 +26,10 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * * @param {object} params * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. + * @param {string} [params.context] - Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context. * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} params.id - Identifier for the stored script or search template. Must be unique within the cluster. - * @param {string} [params.context] - Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context. * @param {object} params.body - The document * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_core/rankEval.d.ts b/api/_core/rankEval.d.ts index 108e9e6b3..58ed4ca3e 100644 --- a/api/_core/rankEval.d.ts +++ b/api/_core/rankEval.d.ts @@ -25,7 +25,7 @@ export interface RankEval_Request extends Global.Params { expand_wildcards?: Common.ExpandWildcards; ignore_unavailable?: boolean; index?: Common.Indices; - search_type?: string; + search_type?: Common.SearchType; } export interface RankEval_RequestBody { diff --git a/api/_core/reindex.d.ts b/api/_core/reindex.d.ts index 57c506c69..e9ae3e334 100644 --- a/api/_core/reindex.d.ts +++ b/api/_core/reindex.d.ts @@ -44,22 +44,7 @@ export interface Reindex_Response extends ApiResponse { body: Reindex_ResponseBody; } -export interface Reindex_ResponseBody { - batches?: number; - created?: number; - deleted?: number; - failures?: Common.BulkIndexByScrollFailure[]; - noops?: number; - requests_per_second?: number; - retries?: Common.Retries; - slice_id?: number; +export type Reindex_ResponseBody = Common.BulkByScrollResponseBase | { task?: Common.TaskId; - throttled_millis?: Common.EpochTimeUnitMillis; - throttled_until_millis?: Common.EpochTimeUnitMillis; - timed_out?: boolean; - took?: Common.DurationValueUnitMillis; - total?: number; - updated?: number; - version_conflicts?: number; } diff --git a/api/_core/search.d.ts b/api/_core/search.d.ts index c940e7a76..421fb4a27 100644 --- a/api/_core/search.d.ts +++ b/api/_core/search.d.ts @@ -84,7 +84,6 @@ export interface Search_RequestBody { from?: number; highlight?: Core_Search.Highlight; indices_boost?: Record[]; - knn?: Common_QueryDsl.KnnQuery | Common_QueryDsl.KnnQuery[]; min_score?: number; pit?: Core_Search.PointInTimeReference; post_filter?: Common_QueryDsl.QueryContainer; diff --git a/api/_core/updateByQuery.d.ts b/api/_core/updateByQuery.d.ts index d4d8deb44..fbdfef3d7 100644 --- a/api/_core/updateByQuery.d.ts +++ b/api/_core/updateByQuery.d.ts @@ -70,22 +70,7 @@ export interface UpdateByQuery_Response extends ApiResponse { body: UpdateByQuery_ResponseBody; } -export interface UpdateByQuery_ResponseBody { - batches?: number; - deleted?: number; - failures?: Common.BulkIndexByScrollFailure[]; - noops?: number; - requests_per_second?: number; - retries?: Common.Retries; +export type UpdateByQuery_ResponseBody = Common.BulkByScrollResponseBase | { task?: Common.TaskId; - throttled?: Common.Duration; - throttled_millis?: Common.DurationValueUnitMillis; - throttled_until?: Common.Duration; - throttled_until_millis?: Common.DurationValueUnitMillis; - timed_out?: boolean; - took?: Common.DurationValueUnitMillis; - total?: number; - updated?: number; - version_conflicts?: number; } diff --git a/api/_types/_common.d.ts b/api/_types/_common.d.ts index 24a1a0367..718127864 100644 --- a/api/_types/_common.d.ts +++ b/api/_types/_common.d.ts @@ -25,25 +25,55 @@ export interface AcknowledgedResponseBase { export type ActionStatusOptions = 'failure' | 'simulated' | 'success' | 'throttled' export interface BaseNode { - attributes: Record; - host: Host; - ip: Ip; + attributes?: Record; + host?: Host; + ip?: Ip; name: Name; roles?: NodeRoles; - transport_address: TransportAddress; + transport_address?: TransportAddress; } -export interface BulkIndexByScrollFailure { +export type BulkByScrollFailure = BulkItemResponseFailure | ScrollableHitSourceSearchFailure + +export interface BulkByScrollResponseBase extends BulkByScrollTaskStatus { + failures: BulkByScrollFailure[]; + timed_out: boolean; + took: number; +} + +export interface BulkByScrollTaskStatus { + batches: number; + canceled?: string; + created?: number; + deleted: number; + noops: number; + requests_per_second: number; + retries: Retries; + slice_id?: number; + slices?: BulkByScrollTaskStatusOrException[]; + throttled?: Duration; + throttled_millis: DurationValueUnitMillis; + throttled_until?: Duration; + throttled_until_millis: DurationValueUnitMillis; + total: number; + updated?: number; + version_conflicts: number; +} + +export type BulkByScrollTaskStatusOrException = BulkByScrollTaskStatus | ErrorCause + +export interface BulkItemResponseFailure { cause: ErrorCause; - id: Id; + id?: Id; index: IndexName; status: number; - type: string; } export type byte = number -export type Bytes = number +export type ByteCount = number + +export type ByteUnit = 'b' | 'g' | 'gb' | 'k' | 'kb' | 'm' | 'mb' | 'p' | 'pb' | 't' | 'tb' export interface ClusterDetails { _shards?: ShardStatistics; @@ -68,8 +98,8 @@ export interface ClusterStatistics { export interface CompletionStats { fields?: Record; - size?: StorageSize; - size_in_bytes: Bytes; + size?: HumanReadableByteCount; + size_in_bytes: ByteCount; } export type Conflicts = 'abort' | 'proceed' @@ -152,20 +182,20 @@ export type Field = string export interface FielddataStats { evictions?: number; fields?: Record; - memory_size?: StorageSize; - memory_size_in_bytes: Bytes; + memory_size?: HumanReadableByteCount; + memory_size_in_bytes: ByteCount; } export interface FieldMemoryUsage { - memory_size?: StorageSize; - memory_size_in_bytes: Bytes; + memory_size?: HumanReadableByteCount; + memory_size_in_bytes: ByteCount; } export type Fields = Field | Field[] export interface FieldSizeUsage { - size?: StorageSize; - size_in_bytes: Bytes; + size?: HumanReadableByteCount; + size_in_bytes: ByteCount; } export type FieldValue = boolean | undefined | number | Record | string @@ -242,6 +272,8 @@ export interface HourAndMinute { export type HttpHeaders = Record +export type HumanReadableByteCount = string + export type IBDistribution = 'll' | 'spl' export type IBLambda = 'df' | 'ttf' @@ -323,14 +355,14 @@ export type Level = 'cluster' | 'indices' | 'shards' export interface MergesStats { current: number; current_docs: number; - current_size?: StorageSize; - current_size_in_bytes: Bytes; + current_size?: HumanReadableByteCount; + current_size_in_bytes: ByteCount; total: number; - total_auto_throttle?: StorageSize; - total_auto_throttle_in_bytes: Bytes; + total_auto_throttle?: HumanReadableByteCount; + total_auto_throttle_in_bytes: ByteCount; total_docs: number; - total_size?: StorageSize; - total_size_in_bytes: Bytes; + total_size?: HumanReadableByteCount; + total_size_in_bytes: ByteCount; total_stopped_time?: Duration; total_stopped_time_in_millis: DurationValueUnitMillis; total_throttled_time?: Duration; @@ -342,8 +374,6 @@ export interface MergesStats { export type Metadata = Record -export type Metrics = string | string[] - export type MinimumShouldMatch = number | string export type MultiTermQueryRewrite = 'constant_score' | 'constant_score_boolean' | 'scoring_boolean' | 'top_terms_N' | 'top_terms_blended_freqs_N' | 'top_terms_boost_N' @@ -375,7 +405,7 @@ export type NodeIds = NodeId | NodeId[] export type NodeName = string -export type NodeRole = 'client' | 'cluster_manager' | 'coordinating_only' | 'data' | 'data_cold' | 'data_content' | 'data_frozen' | 'data_hot' | 'data_warm' | 'ingest' | 'master' | 'ml' | 'remote_cluster_client' | 'transform' | 'voting_only' +export type NodeRole = 'client' | 'coordinating_only' | 'data' | 'data_cold' | 'data_content' | 'data_frozen' | 'data_hot' | 'data_warm' | 'ingest' | 'ml' | 'remote_cluster_client' | 'transform' | 'voting_only' | 'master' | 'cluster_manager' export type NodeRoles = NodeRole[] @@ -418,7 +448,9 @@ export type OpType = 'create' | 'index' export type Password = string -export type Percentage = string | number +export type PercentageNumber = number + +export type PercentageString = string export interface PhaseTook { can_match: uint; @@ -451,8 +483,8 @@ export interface QueryCacheStats { cache_size: number; evictions: number; hit_count: number; - memory_size?: StorageSize; - memory_size_in_bytes: Bytes; + memory_size?: HumanReadableByteCount; + memory_size_in_bytes: ByteCount; miss_count: number; total_count: number; } @@ -511,12 +543,12 @@ export interface RemoteStoreTranslogUploadStats { } export interface RemoteStoreTranslogUploadTotalUploadSizeStats { - failed?: StorageSize; - failed_bytes: Bytes; - started?: StorageSize; - started_bytes: Bytes; - succeeded?: StorageSize; - succeeded_bytes: Bytes; + failed?: HumanReadableByteCount; + failed_bytes: ByteCount; + started?: HumanReadableByteCount; + started_bytes: ByteCount; + succeeded?: HumanReadableByteCount; + succeeded_bytes: ByteCount; } export interface RemoteStoreTranslogUploadTotalUploadsStats { @@ -526,12 +558,12 @@ export interface RemoteStoreTranslogUploadTotalUploadsStats { } export interface RemoteStoreUploadDownloadStats { - failed?: StorageSize; - failed_bytes: Bytes; - started?: StorageSize; - started_bytes: Bytes; - succeeded?: StorageSize; - succeeded_bytes: Bytes; + failed?: HumanReadableByteCount; + failed_bytes: ByteCount; + started?: HumanReadableByteCount; + started_bytes: ByteCount; + succeeded?: HumanReadableByteCount; + succeeded_bytes: ByteCount; } export interface RemoteStoreUploadPressureStats { @@ -539,10 +571,10 @@ export interface RemoteStoreUploadPressureStats { } export interface RemoteStoreUploadRefreshSizeLagStats { - max?: StorageSize; - max_bytes: Bytes; - total?: StorageSize; - total_bytes: Bytes; + max?: HumanReadableByteCount; + max_bytes: ByteCount; + total?: HumanReadableByteCount; + total_bytes: ByteCount; } export interface RemoteStoreUploadStats { @@ -558,8 +590,8 @@ export interface RemoteStoreUploadStats { export interface RequestCacheStats { evictions: number; hit_count: number; - memory_size?: StorageSize; - memory_size_in_bytes: Bytes; + memory_size?: HumanReadableByteCount; + memory_size_in_bytes: ByteCount; miss_count: number; } @@ -577,7 +609,7 @@ export interface Retries { search: number; } -export type Routing = string +export type Routing = string | string[] export interface RrfRank extends RankBase { rank_constant?: number; @@ -613,6 +645,14 @@ export interface ScriptSort { export type ScriptSortType = 'number' | 'string' | 'version' +export interface ScrollableHitSourceSearchFailure { + index?: IndexName; + node?: string; + reason: ErrorCause; + shard?: number; + status: number; +} + export type ScrollId = string export type ScrollIds = ScrollId | ScrollId[] @@ -652,38 +692,38 @@ export interface SearchStats { export type SearchType = 'dfs_query_then_fetch' | 'query_then_fetch' export interface SegmentReplicationStats { - max_bytes_behind: Bytes; - max_replication_lag: Bytes; - total_bytes_behind: Bytes; + max_bytes_behind: ByteCount; + max_replication_lag: ByteCount; + total_bytes_behind: ByteCount; } export interface SegmentsStats { count: number; - doc_values_memory?: StorageSize; - doc_values_memory_in_bytes: Bytes; + doc_values_memory?: HumanReadableByteCount; + doc_values_memory_in_bytes: ByteCount; file_sizes: Record; - fixed_bit_set?: StorageSize; - fixed_bit_set_memory_in_bytes: Bytes; - index_writer_max_memory_in_bytes?: Bytes; - index_writer_memory?: StorageSize; - index_writer_memory_in_bytes: Bytes; + fixed_bit_set?: HumanReadableByteCount; + fixed_bit_set_memory_in_bytes: ByteCount; + index_writer_max_memory_in_bytes?: ByteCount; + index_writer_memory?: HumanReadableByteCount; + index_writer_memory_in_bytes: ByteCount; max_unsafe_auto_id_timestamp: number; - memory?: StorageSize; - memory_in_bytes: Bytes; - norms_memory?: StorageSize; - norms_memory_in_bytes: Bytes; - points_memory?: StorageSize; - points_memory_in_bytes: Bytes; + memory?: HumanReadableByteCount; + memory_in_bytes: ByteCount; + norms_memory?: HumanReadableByteCount; + norms_memory_in_bytes: ByteCount; + points_memory?: HumanReadableByteCount; + points_memory_in_bytes: ByteCount; remote_store?: RemoteStoreStats; segment_replication?: SegmentReplicationStats; - stored_fields_memory?: StorageSize; - stored_fields_memory_in_bytes: Bytes; - term_vectors_memory?: StorageSize; - term_vectors_memory_in_bytes: Bytes; - terms_memory?: StorageSize; - terms_memory_in_bytes: Bytes; - version_map_memory?: StorageSize; - version_map_memory_in_bytes: Bytes; + stored_fields_memory?: HumanReadableByteCount; + stored_fields_memory_in_bytes: ByteCount; + term_vectors_memory?: HumanReadableByteCount; + term_vectors_memory_in_bytes: ByteCount; + terms_memory?: HumanReadableByteCount; + terms_memory_in_bytes: ByteCount; + version_map_memory?: HumanReadableByteCount; + version_map_memory_in_bytes: ByteCount; } export type SequenceNumber = number @@ -737,10 +777,6 @@ export type SortOrder = 'asc' | 'desc' export type SortResults = FieldValue[] -export type StorageSize = string - -export type StorageType = 'b' | 'g' | 'gb' | 'k' | 'kb' | 'm' | 'mb' | 'p' | 'pb' | 't' | 'tb' - export interface StoredScript { lang: ScriptLanguage; options?: Record; @@ -752,10 +788,10 @@ export interface StoredScriptId extends ScriptBase { } export interface StoreStats { - reserved?: StorageSize; - reserved_in_bytes: Bytes; - size?: StorageSize; - size_in_bytes: Bytes; + reserved?: HumanReadableByteCount; + reserved_in_bytes: ByteCount; + size?: HumanReadableByteCount; + size_in_bytes: ByteCount; } export type Stringifiedboolean = boolean | string @@ -799,11 +835,11 @@ export interface TranslogStats { earliest_last_modified_age: number; operations: number; remote_store?: RemoteStoreTranslogStats; - size?: StorageSize; - size_in_bytes: Bytes; + size?: HumanReadableByteCount; + size_in_bytes: ByteCount; uncommitted_operations: number; - uncommitted_size?: StorageSize; - uncommitted_size_in_bytes: Bytes; + uncommitted_size?: HumanReadableByteCount; + uncommitted_size_in_bytes: ByteCount; } export type TransportAddress = string diff --git a/api/_types/_common.query_dsl.d.ts b/api/_types/_common.query_dsl.d.ts index 42f718970..139e020d5 100644 --- a/api/_types/_common.query_dsl.d.ts +++ b/api/_types/_common.query_dsl.d.ts @@ -306,7 +306,7 @@ export interface LikeDocument { version_type?: Common.VersionType; } -export type MatchAllQuery = QueryBase & Record +export type MatchAllQuery = QueryBase export interface MatchBoolPrefixQuery extends QueryBase { analyzer?: string; @@ -518,7 +518,7 @@ export interface QueryContainer { span_term?: Record; span_within?: SpanWithinQuery; term?: Record; - terms?: Record; + terms?: TermsQueryField; terms_set?: Record; text_expansion?: Record; type?: TypeQuery; @@ -708,13 +708,18 @@ export interface TermQuery extends QueryBase { value: Common.FieldValue; } -export type TermsQuery = QueryBase | { +export interface TermsLookupField { id?: Common.Id; index?: Common.IndexName; path?: Common.Field; routing?: Common.Routing; } +export interface TermsQueryField { + boost?: number; + [key: string]: any | TermsLookupField | string[]; +} + export interface TermsSetQuery extends QueryBase { minimum_should_match_field?: Common.Field; minimum_should_match_script?: Common.Script; diff --git a/api/_types/_core.bulk.d.ts b/api/_types/_core.bulk.d.ts index 2545b249f..6d2caad42 100644 --- a/api/_types/_core.bulk.d.ts +++ b/api/_types/_core.bulk.d.ts @@ -17,11 +17,11 @@ import * as Common from './_common' import * as Core_Search from './_core.search' -export type CreateOperation = WriteOperation & Record +export type CreateOperation = WriteOperation -export type DeleteOperation = OperationBase & Record +export type DeleteOperation = OperationBase -export type IndexOperation = WriteOperation & Record +export type IndexOperation = WriteOperation export interface OperationBase { _id?: Common.Id; diff --git a/api/_types/cat._common.d.ts b/api/_types/cat._common.d.ts index 77be2a789..debe5fcf3 100644 --- a/api/_types/cat._common.d.ts +++ b/api/_types/cat._common.d.ts @@ -14,6 +14,7 @@ * modify the API generator. */ +import * as Common from './_common' export interface CatPitSegmentsRecord { committed?: string; @@ -36,14 +37,14 @@ export interface CatSegmentReplicationRecord { bytes?: string; bytes_behind?: string; bytes_fetched?: string; - bytes_percent?: string; + bytes_percent?: Common.PercentageString; bytes_total?: string; checkpoints_behind?: string; current_lag?: string; file_diff_stage_time_taken?: string; files?: string; files_fetched?: string; - files_percent?: string; + files_percent?: Common.PercentageString; files_total?: string; finalize_replication_stage_time_taken?: string; get_checkpoint_info_stage_time_taken?: string; diff --git a/api/_types/cat.allocation.d.ts b/api/_types/cat.allocation.d.ts index 8a8cbc0a3..0aaa51ea2 100644 --- a/api/_types/cat.allocation.d.ts +++ b/api/_types/cat.allocation.d.ts @@ -19,7 +19,7 @@ import * as Common from './_common' export interface AllocationRecord { 'disk.avail'?: undefined | string; 'disk.indices'?: undefined | string; - 'disk.percent'?: Common.Percentage | undefined; + 'disk.percent'?: Common.PercentageString | undefined; 'disk.total'?: undefined | string; 'disk.used'?: undefined | string; host?: Common.Host | undefined; diff --git a/api/_types/cat.health.d.ts b/api/_types/cat.health.d.ts index 5097f26dc..e48fb1a4c 100644 --- a/api/_types/cat.health.d.ts +++ b/api/_types/cat.health.d.ts @@ -17,7 +17,7 @@ import * as Common from './_common' export interface HealthRecord { - active_shards_percent?: string; + active_shards_percent?: Common.PercentageString; cluster?: string; discovered_cluster_manager?: string; discovered_master?: string; diff --git a/api/_types/cat.nodes.d.ts b/api/_types/cat.nodes.d.ts index 22b9c4e09..680ee6877 100644 --- a/api/_types/cat.nodes.d.ts +++ b/api/_types/cat.nodes.d.ts @@ -29,12 +29,12 @@ export interface NodesRecord { 'disk.avail'?: string; 'disk.total'?: string; 'disk.used'?: string; - 'disk.used_percent'?: Common.Percentage; + 'disk.used_percent'?: Common.PercentageString; 'fielddata.evictions'?: string; 'fielddata.memory_size'?: string; 'file_desc.current'?: string; 'file_desc.max'?: string; - 'file_desc.percent'?: Common.Percentage; + 'file_desc.percent'?: Common.PercentageString; flavor?: string; 'flush.total'?: string; 'flush.total_time'?: string; @@ -47,7 +47,7 @@ export interface NodesRecord { 'get.total'?: string; 'heap.current'?: string; 'heap.max'?: string; - 'heap.percent'?: Common.Percentage; + 'heap.percent'?: Common.PercentageString; http_address?: string; id?: Common.Id; 'indexing.delete_current'?: string; @@ -81,7 +81,7 @@ export interface NodesRecord { 'query_cache.miss_count'?: string; 'ram.current'?: string; 'ram.max'?: string; - 'ram.percent'?: Common.Percentage; + 'ram.percent'?: Common.PercentageString; 'refresh.external_time'?: string; 'refresh.external_total'?: string; 'refresh.listeners'?: string; diff --git a/api/_types/cat.recovery.d.ts b/api/_types/cat.recovery.d.ts index ad0ceffb6..4c69c80a5 100644 --- a/api/_types/cat.recovery.d.ts +++ b/api/_types/cat.recovery.d.ts @@ -18,11 +18,11 @@ import * as Common from './_common' export interface RecoveryRecord { bytes?: string; - bytes_percent?: Common.Percentage; + bytes_percent?: Common.PercentageString; bytes_recovered?: string; bytes_total?: string; files?: string; - files_percent?: Common.Percentage; + files_percent?: Common.PercentageString; files_recovered?: string; files_total?: string; index?: Common.IndexName; @@ -40,7 +40,7 @@ export interface RecoveryRecord { target_node?: string; time?: Common.Duration; translog_ops?: string; - translog_ops_percent?: Common.Percentage; + translog_ops_percent?: Common.PercentageString; translog_ops_recovered?: string; type?: string; } diff --git a/api/_types/cat.segments.d.ts b/api/_types/cat.segments.d.ts index c0319b293..12fd767b0 100644 --- a/api/_types/cat.segments.d.ts +++ b/api/_types/cat.segments.d.ts @@ -29,7 +29,7 @@ export interface SegmentsRecord { searchable?: string; segment?: string; shard?: string; - size?: Common.StorageSize; + size?: Common.HumanReadableByteCount; 'size.memory'?: string; version?: Common.VersionString; } diff --git a/api/_types/cluster.allocation_explain.d.ts b/api/_types/cluster.allocation_explain.d.ts index 71e8b3164..3c9a77bc8 100644 --- a/api/_types/cluster.allocation_explain.d.ts +++ b/api/_types/cluster.allocation_explain.d.ts @@ -28,7 +28,7 @@ export interface AllocationStore { allocation_id: string; found: boolean; in_sync: boolean; - matching_size_in_bytes: Common.Bytes; + matching_size_in_bytes: Common.ByteCount; matching_sync_id: boolean; store_exception: string; } @@ -38,7 +38,7 @@ export interface ClusterInfo { reserved_sizes: ReservedSize[]; shard_data_set_sizes?: Record; shard_paths: Record; - shard_sizes: Record; + shard_sizes: Record; } export interface CurrentNode { @@ -52,15 +52,15 @@ export interface CurrentNode { export type Decision = 'allocation_delayed' | 'awaiting_info' | 'no' | 'no_attempt' | 'no_valid_shard_copy' | 'throttled' | 'worse_balance' | 'yes' export interface DiskUsage { - free?: Common.StorageSize; - free_bytes: Common.Bytes; - free_disk_percent: number; + free?: Common.HumanReadableByteCount; + free_bytes: Common.ByteCount; + free_disk_percent: Common.PercentageNumber; path: string; - total?: Common.StorageSize; - total_bytes: Common.Bytes; - used?: Common.StorageSize; - used_bytes: Common.Bytes; - used_disk_percent: number; + total?: Common.HumanReadableByteCount; + total_bytes: Common.ByteCount; + used?: Common.HumanReadableByteCount; + used_bytes: Common.ByteCount; + used_disk_percent: Common.PercentageNumber; } export interface NodeAllocationExplanation { diff --git a/api/_types/cluster.health.d.ts b/api/_types/cluster.health.d.ts index 0e3f1def8..a2c6418b5 100644 --- a/api/_types/cluster.health.d.ts +++ b/api/_types/cluster.health.d.ts @@ -28,7 +28,8 @@ export interface AwarenessAttributeStats { export interface HealthResponseBody { active_primary_shards: number; active_shards: number; - active_shards_percent_as_number: Common.Percentage; + active_shards_percent?: Common.PercentageString; + active_shards_percent_as_number: Common.PercentageNumber; awareness_attributes?: Record; cluster_name: Common.Name; delayed_unassigned_shards: number; diff --git a/api/_types/cluster.reroute.d.ts b/api/_types/cluster.reroute.d.ts index a6bfc2939..d498c9a82 100644 --- a/api/_types/cluster.reroute.d.ts +++ b/api/_types/cluster.reroute.d.ts @@ -51,6 +51,8 @@ export interface CommandMoveAction { to_node: string; } +export type Metric = '_all' | 'blocks' | 'cluster_manager_node' | 'master_node' | 'metadata' | 'nodes' | 'routing_nodes' | 'routing_table' | 'version' + export interface RerouteDecision { decider: string; decision: string; diff --git a/api/_types/cluster.stats.d.ts b/api/_types/cluster.stats.d.ts index c1390513d..581324b84 100644 --- a/api/_types/cluster.stats.d.ts +++ b/api/_types/cluster.stats.d.ts @@ -29,14 +29,14 @@ export interface CharFilterTypes { } export interface ClusterFileSystem { - available?: Common.StorageSize; - available_in_bytes: Common.Bytes; - cache_reserved?: Common.StorageSize; - cache_reserved_in_bytes?: Common.Bytes; - free?: Common.StorageSize; - free_in_bytes: Common.Bytes; - total?: Common.StorageSize; - total_in_bytes: Common.Bytes; + available?: Common.HumanReadableByteCount; + available_in_bytes: Common.ByteCount; + cache_reserved?: Common.HumanReadableByteCount; + cache_reserved_in_bytes?: Common.ByteCount; + free?: Common.HumanReadableByteCount; + free_in_bytes: Common.ByteCount; + total?: Common.HumanReadableByteCount; + total_in_bytes: Common.ByteCount; } export interface ClusterIndices { @@ -80,10 +80,10 @@ export interface ClusterJvm { } export interface ClusterJvmMemory { - heap_max?: Common.StorageSize; - heap_max_in_bytes: Common.Bytes; - heap_used?: Common.StorageSize; - heap_used_in_bytes: Common.Bytes; + heap_max?: Common.HumanReadableByteCount; + heap_max_in_bytes: Common.ByteCount; + heap_used?: Common.HumanReadableByteCount; + heap_used_in_bytes: Common.ByteCount; } export interface ClusterJvmVersion { @@ -165,7 +165,7 @@ export interface ClusterProcess { } export interface ClusterProcessCpu { - percent: number; + percent: Common.PercentageNumber; } export interface ClusterProcessOpenFileDescriptors { @@ -202,8 +202,8 @@ export interface FieldTypesMappings { field_types: FieldTypes[]; runtime_field_types?: RuntimeFieldTypes[]; total_deduplicated_field_count?: number; - total_deduplicated_mapping_size?: Common.StorageSize; - total_deduplicated_mapping_size_in_bytes?: Common.Bytes; + total_deduplicated_mapping_size?: Common.HumanReadableByteCount; + total_deduplicated_mapping_size_in_bytes?: Common.ByteCount; total_field_count?: number; } @@ -213,25 +213,25 @@ export interface IndexingPressure { export interface IndexingPressureMemory { current: IndexingPressureMemorySummary; - limit_in_bytes: Common.Bytes; + limit_in_bytes: Common.ByteCount; total: IndexingPressureMemorySummary; } export interface IndexingPressureMemorySummary { - all_in_bytes: Common.Bytes; - combined_coordinating_and_primary_in_bytes: Common.Bytes; - coordinating_in_bytes: Common.Bytes; + all_in_bytes: Common.ByteCount; + combined_coordinating_and_primary_in_bytes: Common.ByteCount; + coordinating_in_bytes: Common.ByteCount; coordinating_rejections?: number; - primary_in_bytes: Common.Bytes; + primary_in_bytes: Common.ByteCount; primary_rejections?: number; - replica_in_bytes: Common.Bytes; + replica_in_bytes: Common.ByteCount; replica_rejections?: number; } export interface IndicesVersions { index_count: number; primary_shard_count: number; - total_primary_bytes: Common.Bytes; + total_primary_bytes: Common.ByteCount; version: Common.VersionString; } @@ -242,15 +242,15 @@ export interface NodePackagingType { } export interface OperatingSystemMemoryInfo { - adjusted_total_in_bytes?: Common.Bytes; - free?: Common.StorageSize; - free_in_bytes: Common.Bytes; - free_percent: number; - total?: Common.StorageSize; - total_in_bytes: Common.Bytes; - used?: Common.StorageSize; - used_in_bytes: Common.Bytes; - used_percent: number; + adjusted_total_in_bytes?: Common.ByteCount; + free?: Common.HumanReadableByteCount; + free_in_bytes: Common.ByteCount; + free_percent: Common.PercentageNumber; + total?: Common.HumanReadableByteCount; + total_in_bytes: Common.ByteCount; + used?: Common.HumanReadableByteCount; + used_in_bytes: Common.ByteCount; + used_percent: Common.PercentageNumber; } export interface RuntimeFieldTypes { diff --git a/api/_types/flow_framework.common.d.ts b/api/_types/flow_framework.common.d.ts index 688043d56..b579469aa 100644 --- a/api/_types/flow_framework.common.d.ts +++ b/api/_types/flow_framework.common.d.ts @@ -15,6 +15,10 @@ */ +export type All = boolean + +export type AllowDelete = string + export interface FlowFrameworkCreate { description?: string; name: string; @@ -48,6 +52,43 @@ export interface FlowFrameworkUpdate { name?: string; use_case?: string; version?: version; + workflows?: Record; +} + +export interface hits { + hits?: itemsObject[]; + max_score?: number; + total?: total; +} + +export interface itemsObject { + _id?: string; + _index?: string; + _primary_term?: number; + _score?: number; + _seq_no?: number; + _source?: FlowFrameworkGetResponse; + _version?: number; +} + +export type Provision = boolean + +export interface query { + match?: Record; + match_all?: Record; +} + +export type Reprovision = boolean + +export interface SearchStateResponse { + provisioning_progress?: string; + state?: string; + user?: user; + workflow_id?: string; +} + +export interface SearchWorkflowRequest { + query?: query; } export interface shards { @@ -56,6 +97,31 @@ export interface shards { total?: number; } +export interface StateHits { + hits?: StateItems[]; + max_score?: number; + total?: total; +} + +export interface StateItems { + _id?: string; + _index?: string; + _primary_term?: number; + _score?: number; + _seq_no?: number; + _source?: SearchStateResponse; + _version?: number; +} + +export interface total { + relation?: string; + value?: number; +} + +export type UpdateFields = boolean + +export type UseCase = string + export interface user { backend_roles?: string[]; custom_attribute_names?: string[]; @@ -64,8 +130,55 @@ export interface user { user_requested_tenant?: string; } +export type UserProvidedSubstitutionExpressions = Record + +export type Validation = string + export interface version { compatibility?: string[]; template?: string; } +export type WorkflowID = string + +export interface WorkflowSearchResponse { + _shards?: shards; + hits?: hits; + timed_out?: boolean; + took?: number; +} + +export interface WorkflowSearchStateResponse { + _shards?: shards; + hits?: StateHits; + timed_out?: boolean; + took?: number; +} + +export interface WorkFlowStatusDefaultResponse { + error?: string; + resources_created?: string[]; + state?: string; + workflow_id?: string; +} + +export interface WorkFlowStatusFullResponse { + error?: string; + provision_end_time?: string; + provision_start_time?: string; + provisioning_progress?: string; + resources_created?: string[]; + state?: 'COMPLETED' | 'FAILED' | 'NOT_STARTED' | 'PROVISIONING'; + user?: user; + user_outputs?: string[]; + workflow_id?: string; +} + +export interface WorkflowStep { + inputs?: string[]; + outputs?: string[]; + required_plugins?: string[]; +} + +export type WorkflowStepName = string + diff --git a/api/_types/flow_framework.errors.d.ts b/api/_types/flow_framework.errors.d.ts index 540e29dda..b8096f5f8 100644 --- a/api/_types/flow_framework.errors.d.ts +++ b/api/_types/flow_framework.errors.d.ts @@ -15,21 +15,66 @@ */ -export type BadRequestError = Record +export interface BadRequestError { + error?: string; + status?: number; +} export type ConflictError = Record +export interface DeprovisioningError { + error: string; +} + +export interface DeprovisioningForbiddenError { + error: string; +} + +export interface DuplicateKeyError { + error?: string; + status?: number; +} + export type FlowFrameworkAPIDisabledError = Record +export type InvalidParameterError = Record + +export interface InvalidRequestBodyFieldError { + error?: string; + status?: number; +} + +export type InvalidTemplateVersionError = Record + export type MaxWorkflowsLimitError = Record export type MissingParameterError = Record export type ParameterConflictError = Record +export interface RequestBodyParsingFailedError { + error?: string; + status?: number; +} + +export interface RequestTimeoutError { + error?: string; + status?: number; +} + +export interface TemplateNameRequiredError { + error?: string; +} + export type TemplateNotFoundError = Record +export type UnsupportedFieldUpdateError = Record + export type WorkFlowIdNullError = Record +export type WorkflowParsingError = Record + export type WorkflowSaveError = Record +export type WorkflowStepsRetrieveError = Record + diff --git a/api/_types/indices._common.d.ts b/api/_types/indices._common.d.ts index d9ed806da..51679ea5a 100644 --- a/api/_types/indices._common.d.ts +++ b/api/_types/indices._common.d.ts @@ -80,13 +80,13 @@ export interface DataStreamLifecycleRolloverConditions { max_age?: string; max_docs?: number; max_primary_shard_docs?: number; - max_primary_shard_size?: Common.StorageSize; - max_size?: Common.StorageSize; + max_primary_shard_size?: Common.HumanReadableByteCount; + max_size?: Common.HumanReadableByteCount; min_age?: Common.Duration; min_docs?: number; min_primary_shard_docs?: number; - min_primary_shard_size?: Common.StorageSize; - min_size?: Common.StorageSize; + min_primary_shard_size?: Common.HumanReadableByteCount; + min_size?: Common.HumanReadableByteCount; } export interface DataStreamLifecycleWithRollover { @@ -486,7 +486,7 @@ export interface TemplateMapping { export interface Translog { durability?: TranslogDurability; - flush_threshold_size?: Common.StorageSize; + flush_threshold_size?: Common.HumanReadableByteCount; retention?: TranslogRetention; sync_interval?: Common.Duration; } @@ -495,6 +495,6 @@ export type TranslogDurability = 'async' | 'request' export interface TranslogRetention { age?: Common.Duration; - size?: Common.StorageSize; + size?: Common.HumanReadableByteCount; } diff --git a/api/_types/indices.data_streams_stats.d.ts b/api/_types/indices.data_streams_stats.d.ts index 6131cc6d9..611def92d 100644 --- a/api/_types/indices.data_streams_stats.d.ts +++ b/api/_types/indices.data_streams_stats.d.ts @@ -20,7 +20,7 @@ export interface DataStreamsStatsItem { backing_indices: number; data_stream: Common.Name; maximum_timestamp: Common.EpochTimeUnitMillis; - store_size?: Common.StorageSize; - store_size_bytes: Common.Bytes; + store_size?: Common.HumanReadableByteCount; + store_size_bytes: Common.ByteCount; } diff --git a/api/_types/indices.recovery.d.ts b/api/_types/indices.recovery.d.ts index 3b7286c9c..a38ba5c06 100644 --- a/api/_types/indices.recovery.d.ts +++ b/api/_types/indices.recovery.d.ts @@ -23,20 +23,20 @@ export interface FileDetails { } export interface RecoveryBytes { - percent: Common.Percentage; - recovered?: Common.StorageSize; - recovered_from_snapshot?: Common.StorageSize; - recovered_from_snapshot_in_bytes?: Common.Bytes; - recovered_in_bytes: Common.Bytes; - reused?: Common.StorageSize; - reused_in_bytes: Common.Bytes; - total?: Common.StorageSize; - total_in_bytes: Common.Bytes; + percent: Common.PercentageString; + recovered?: Common.HumanReadableByteCount; + recovered_from_snapshot?: Common.HumanReadableByteCount; + recovered_from_snapshot_in_bytes?: Common.ByteCount; + recovered_in_bytes: Common.ByteCount; + reused?: Common.HumanReadableByteCount; + reused_in_bytes: Common.ByteCount; + total?: Common.HumanReadableByteCount; + total_in_bytes: Common.ByteCount; } export interface RecoveryFiles { details?: FileDetails[]; - percent: Common.Percentage; + percent: Common.PercentageString; recovered: number; reused: number; total: number; @@ -100,7 +100,7 @@ export interface ShardRecovery { } export interface TranslogStatus { - percent: Common.Percentage; + percent: Common.PercentageString; recovered: number; total: number; total_on_start: number; diff --git a/api/_types/indices.rollover.d.ts b/api/_types/indices.rollover.d.ts index d7ebbe475..e0d941a73 100644 --- a/api/_types/indices.rollover.d.ts +++ b/api/_types/indices.rollover.d.ts @@ -21,16 +21,16 @@ export interface RolloverConditions { max_age_millis?: Common.DurationValueUnitMillis; max_docs?: number; max_primary_shard_docs?: number; - max_primary_shard_size?: Common.StorageSize; - max_primary_shard_size_bytes?: Common.Bytes; - max_size?: Common.StorageSize; - max_size_bytes?: Common.Bytes; + max_primary_shard_size?: Common.HumanReadableByteCount; + max_primary_shard_size_bytes?: Common.ByteCount; + max_size?: Common.HumanReadableByteCount; + max_size_bytes?: Common.ByteCount; min_age?: Common.Duration; min_docs?: number; min_primary_shard_docs?: number; - min_primary_shard_size?: Common.StorageSize; - min_primary_shard_size_bytes?: Common.Bytes; - min_size?: Common.StorageSize; - min_size_bytes?: Common.Bytes; + min_primary_shard_size?: Common.HumanReadableByteCount; + min_primary_shard_size_bytes?: Common.ByteCount; + min_size?: Common.HumanReadableByteCount; + min_size_bytes?: Common.ByteCount; } diff --git a/api/_types/indices.segments.d.ts b/api/_types/indices.segments.d.ts index 0a37e1865..d48c4f9da 100644 --- a/api/_types/indices.segments.d.ts +++ b/api/_types/indices.segments.d.ts @@ -26,12 +26,12 @@ export interface Segment { compound: boolean; deleted_docs: number; generation: number; - memory?: Common.StorageSize; - memory_in_bytes?: Common.Bytes; + memory?: Common.HumanReadableByteCount; + memory_in_bytes?: Common.ByteCount; num_docs: number; search: boolean; - size?: Common.StorageSize; - size_in_bytes: Common.Bytes; + size?: Common.HumanReadableByteCount; + size_in_bytes: Common.ByteCount; version: Common.VersionString; } diff --git a/api/_types/indices.shard_stores.d.ts b/api/_types/indices.shard_stores.d.ts index 89dcb6527..c60f157b6 100644 --- a/api/_types/indices.shard_stores.d.ts +++ b/api/_types/indices.shard_stores.d.ts @@ -33,9 +33,9 @@ export interface ShardStoreException { type: string; } -export type ShardStoreStatus = 'all' | 'green' | 'red' | 'yellow' - export interface ShardStoreWrapper { stores: ShardStore[]; } +export type Status = 'all' | 'green' | 'red' | 'yellow' + diff --git a/api/_types/indices.stats.d.ts b/api/_types/indices.stats.d.ts index 7f4ad4f2c..25083808c 100644 --- a/api/_types/indices.stats.d.ts +++ b/api/_types/indices.stats.d.ts @@ -57,6 +57,8 @@ export interface IndicesStats { uuid: Common.Uuid; } +export type Metric = '_all' | 'completion' | 'docs' | 'fielddata' | 'flush' | 'get' | 'indexing' | 'merge' | 'query_cache' | 'recovery' | 'refresh' | 'request_cache' | 'search' | 'segments' | 'store' | 'suggest' | 'translog' | 'warmer' + export interface ShardCommit { generation: number; id: Common.Id; @@ -65,13 +67,13 @@ export interface ShardCommit { } export interface ShardFileSizeInfo { - average_size_in_bytes?: Common.Bytes; + average_size_in_bytes?: Common.ByteCount; count?: number; description: string; - max_size_in_bytes?: Common.Bytes; - min_size_in_bytes?: Common.Bytes; - size?: Common.StorageSize; - size_in_bytes: Common.Bytes; + max_size_in_bytes?: Common.ByteCount; + min_size_in_bytes?: Common.ByteCount; + size?: Common.HumanReadableByteCount; + size_in_bytes: Common.ByteCount; } export interface ShardLease { diff --git a/api/_types/ism._common.d.ts b/api/_types/ism._common.d.ts new file mode 100644 index 000000000..4ba16cfbf --- /dev/null +++ b/api/_types/ism._common.d.ts @@ -0,0 +1,259 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import * as Common from './_common' + +export interface Action { + alias?: ActionAlias; + allocation?: ActionAllocation; + close?: ActionClose; + custom?: ActionCustom; + delete?: ActionDelete; + force_merge?: ActionForceMerge; + index_priority?: ActionIndexPriority; + notification?: ActionNotification; + open?: ActionOpen; + read_only?: ActionReadOnly; + read_write?: ActionReadWrite; + replica_count?: ActionReplicaCount; + retry?: ActionRetry; + rollover?: ActionRollover; + rollup?: ActionRollup; + shrink?: ActionShrink; + snapshot?: ActionSnapshot; + timeout?: ActionTimeout; + transform?: ActionTransform; +} + +export interface ActionAlias { + actions?: Record; +} + +export interface ActionAllocation { + exclude?: Record; + include?: Record; + require?: Record; + wait_for?: boolean; +} + +export type ActionClose = Record + +export type ActionCustom = Record + +export type ActionDelete = Record + +export interface ActionForceMerge { + max_num_segments?: number; +} + +export interface ActionIndexPriority { + priority?: number; +} + +export type ActionNotification = Record + +export type ActionOpen = Record + +export type ActionReadOnly = Record + +export type ActionReadWrite = Record + +export interface ActionReplicaCount { + number_of_replicas?: number; +} + +export interface ActionRetry { + backoff?: string; + count?: number; + delay?: string; +} + +export interface ActionRollover { + copy_alias?: boolean; + min_doc_count?: number; + min_index_age?: number; + min_primary_shard_size?: number; + min_size?: number; +} + +export type ActionRollup = Record + +export type ActionShrink = Record + +export interface ActionSnapshot { + include_global_state?: boolean; + repository?: string; + snapshot?: string; +} + +export interface ActionTimeout { + timeout?: Record; +} + +export type ActionTransform = Record + +export interface AddPolicyRequest { + policy_id: string; +} + +export type AddPolicyResponse = ChangePolicyResponse + +export interface ChangePolicyRequest { + include?: IncludeState[]; + policy_id: string; + state?: string; +} + +export type ChangePolicyResponse = ChangeResponse + +export interface ChangeResponse { + failed_indices?: FailedIndex[]; + failures?: boolean; + updated_indices?: number; +} + +export interface Channel { + id?: string; +} + +export type DeletePolicyResponse = Common.WriteResponseBase + +export interface ErrorNotification { + channel?: Channel; + destination?: ErrorNotificationDestination; + message_template?: Record; +} + +export interface ErrorNotificationChime { + url?: string; +} + +export interface ErrorNotificationDestination { + last_update_time?: number; + name?: string; + [key: string]: any | ErrorNotificationChime | ErrorNotificationSlack; +} + +export interface ErrorNotificationSlack { + custom_webhook?: SlackCustomWebhook; + url?: string; +} + +export interface ExplainIndexResponse { + total_managed_indices?: number; + [key: string]: any | ExplainPolicy; +} + +export interface ExplainPolicy { + enabled?: boolean | undefined; + 'index.opendistro.index_state_management.policy_id'?: undefined | string; + 'index.plugins.index_state_management.policy_id'?: undefined | string; +} + +export interface FailedIndex { + index_name?: string; + index_uuid?: string; + reason?: string; +} + +export interface GetPoliciesResponse { + policies?: PolicyWithMetadata[]; + total_policies?: number; +} + +export type GetPolicyResponse = PolicyWithMetadata + +export interface IncludeState { + state?: string; +} + +export interface IsmTemplate { + index_patterns?: string[]; + last_updated_time?: number; + priority?: number; +} + +export interface Metadata { + _id?: Common.Id; + _primary_term?: number; + _seq_no?: Common.SequenceNumber; + _version?: Common.VersionNumber; +} + +export interface Policy { + default_state?: string; + description?: string; + error_notification?: ErrorNotification | undefined; + ism_template?: IsmTemplate | undefined | IsmTemplate[]; + last_updated_time?: number; + policy_id?: string; + schema_version?: number; + states?: States[]; +} + +export interface PolicyEnvelope { + policy?: Policy; +} + +export type PolicyWithMetadata = Metadata, PolicyEnvelope & Record + +export type PutPolicyRequest = PolicyEnvelope + +export interface PutPolicyResponse extends Metadata { + policy?: PolicyEnvelope; +} + +export interface RefreshSearchAnalyzersResponse { + _shards?: Common.ShardStatistics; + successful_refresh_details?: RefreshSearchAnalyzersResponseDetails[]; +} + +export interface RefreshSearchAnalyzersResponseDetails { + index?: string; + refreshed_analyzers?: string[]; +} + +export type RemovePolicyResponse = ChangePolicyResponse + +export interface RetryIndexRequest { + state: string; +} + +export type RetryIndexResponse = ChangeResponse + +export interface SlackCustomWebhook { + header_params?: Record; + host?: string; + password?: string; + path?: string; + port?: number; + query_params?: Record; + scheme?: string; + url?: string; + username?: string; +} + +export interface States { + actions?: Action[]; + name?: string; + transitions?: Transition[]; +} + +export interface Transition { + conditions?: Record; + state_name?: string; +} + diff --git a/api/_types/ml._common.d.ts b/api/_types/ml._common.d.ts index 63c40a2dc..28ff1e336 100644 --- a/api/_types/ml._common.d.ts +++ b/api/_types/ml._common.d.ts @@ -16,11 +16,63 @@ import * as Common from './_common' +export interface Action { + action_type?: string; + headers?: Headers; + method?: string; + post_process_function?: string; + pre_process_function?: string; + request_body?: string; + url?: string; +} + +export interface ClientConfig { + connection_timeout?: number; + max_connection?: number; + max_retry_times?: number; + read_timeout?: number; + retry_backoff_millis?: number; + retry_backoff_policy?: string; + retry_timeout_seconds?: number; +} + +export interface CreateConnectorRequest { + actions: Action[]; + client_config?: ClientConfig; + credential: Credential; + description: string; + name: string; + parameters: Parameters; + protocol: string; + version: number; +} + +export interface Credential { + access_key?: string; + secret_key?: string; + session_token?: string; + [key: string]: any; +} + +export interface Headers { + content_type?: string; + [key: string]: any; +} + export interface HitsTotal { relation: string; value: number; } +export interface LLM { + model_id?: string; + parameters?: Parameters; +} + +export interface Memory { + type?: string; +} + export interface ModelGroup { access: string; created_time?: number; @@ -35,6 +87,19 @@ export interface ModelGroupRegistration { status: string; } +export type Parameters = Record + +export interface RegisterAgentsRequest { + app_type?: string; + description?: string; + llm?: LLM; + memory?: Memory; + name: string; + parameters?: Parameters; + tools?: ToolItems[]; + type: string; +} + export interface SearchModelsHits { hits: SearchModelsHitsHit[]; total: HitsTotal; @@ -68,6 +133,13 @@ export interface Task { worker_node?: Common.NodeIds[]; } +export interface ToolItems { + name?: string; + parameters?: Parameters; + type?: string; + [key: string]: any; +} + export interface UndeployModelNode { stats?: UndeployModelNodeStats; } diff --git a/api/_types/nodes._common.d.ts b/api/_types/nodes._common.d.ts index d9be31eb2..6c9fd7dac 100644 --- a/api/_types/nodes._common.d.ts +++ b/api/_types/nodes._common.d.ts @@ -28,10 +28,10 @@ export interface AdaptiveSelection { } export interface Breaker { - estimated_size?: Common.StorageSize; - estimated_size_in_bytes?: Common.Bytes; - limit_size?: Common.StorageSize; - limit_size_in_bytes?: Common.Bytes; + estimated_size?: Common.HumanReadableByteCount; + estimated_size_in_bytes?: Common.ByteCount; + limit_size?: Common.HumanReadableByteCount; + limit_size_in_bytes?: Common.ByteCount; overhead?: number; tripped?: number; } @@ -71,7 +71,7 @@ export interface Client { opened_time_millis?: number; remote_address?: string; request_count?: number; - request_size_bytes?: Common.Bytes; + request_size_bytes?: Common.ByteCount; x_opaque_id?: string; } @@ -122,7 +122,7 @@ export interface Context { export interface Cpu { load_average?: Record; - percent?: number; + percent?: Common.PercentageNumber; sys?: Common.Duration; sys_in_millis?: Common.DurationValueUnitMillis; total?: Common.Duration; @@ -137,23 +137,23 @@ export interface CpuAcct { } export interface DataPathStats { - available?: Common.StorageSize; - available_in_bytes?: Common.Bytes; - cache_reserved?: Common.StorageSize; - cache_reserved_in_bytes?: Common.Bytes; + available?: Common.HumanReadableByteCount; + available_in_bytes?: Common.ByteCount; + cache_reserved?: Common.HumanReadableByteCount; + cache_reserved_in_bytes?: Common.ByteCount; disk_queue?: string; - disk_read_size?: Common.StorageSize; - disk_read_size_in_bytes?: Common.Bytes; + disk_read_size?: Common.HumanReadableByteCount; + disk_read_size_in_bytes?: Common.ByteCount; disk_reads?: number; - disk_write_size?: Common.StorageSize; - disk_write_size_in_bytes?: Common.Bytes; + disk_write_size?: Common.HumanReadableByteCount; + disk_write_size_in_bytes?: Common.ByteCount; disk_writes?: number; - free?: Common.StorageSize; - free_in_bytes?: Common.Bytes; + free?: Common.HumanReadableByteCount; + free_in_bytes?: Common.ByteCount; mount?: string; path?: string; - total?: Common.StorageSize; - total_in_bytes?: Common.Bytes; + total?: Common.HumanReadableByteCount; + total_in_bytes?: Common.ByteCount; type?: string; } @@ -167,8 +167,8 @@ export interface Discovery { } export interface ExtendedMemoryStats extends MemoryStats { - free_percent?: number; - used_percent?: number; + free_percent?: Common.PercentageNumber; + used_percent?: Common.PercentageNumber; } export interface FileSystem { @@ -179,14 +179,14 @@ export interface FileSystem { } export interface FileSystemTotal { - available?: Common.StorageSize; - available_in_bytes?: Common.Bytes; - cache_reserved?: Common.StorageSize; - cache_reserved_in_bytes?: Common.Bytes; - free?: Common.StorageSize; - free_in_bytes?: Common.Bytes; - total?: Common.StorageSize; - total_in_bytes?: Common.Bytes; + available?: Common.HumanReadableByteCount; + available_in_bytes?: Common.ByteCount; + cache_reserved?: Common.HumanReadableByteCount; + cache_reserved_in_bytes?: Common.ByteCount; + free?: Common.HumanReadableByteCount; + free_in_bytes?: Common.ByteCount; + total?: Common.HumanReadableByteCount; + total_in_bytes?: Common.ByteCount; } export interface GarbageCollector { @@ -211,8 +211,8 @@ export interface IndexingPressure { export interface IndexingPressureMemory { current?: PressureMemory; - limit?: Common.StorageSize; - limit_in_bytes?: Common.Bytes; + limit?: Common.HumanReadableByteCount; + limit_in_bytes?: Common.ByteCount; total?: PressureMemory; } @@ -266,17 +266,17 @@ export interface JvmClasses { } export interface JvmMemoryStats { - heap_committed?: Common.StorageSize; - heap_committed_in_bytes?: Common.Bytes; - heap_max?: Common.StorageSize; - heap_max_in_bytes?: Common.Bytes; - heap_used?: Common.StorageSize; - heap_used_in_bytes?: Common.Bytes; - heap_used_percent?: number; - non_heap_committed?: Common.StorageSize; - non_heap_committed_in_bytes?: Common.Bytes; - non_heap_used?: Common.StorageSize; - non_heap_used_in_bytes?: Common.Bytes; + heap_committed?: Common.HumanReadableByteCount; + heap_committed_in_bytes?: Common.ByteCount; + heap_max?: Common.HumanReadableByteCount; + heap_max_in_bytes?: Common.ByteCount; + heap_used?: Common.HumanReadableByteCount; + heap_used_in_bytes?: Common.ByteCount; + heap_used_percent?: Common.PercentageNumber; + non_heap_committed?: Common.HumanReadableByteCount; + non_heap_committed_in_bytes?: Common.ByteCount; + non_heap_used?: Common.HumanReadableByteCount; + non_heap_used_in_bytes?: Common.ByteCount; pools?: Record; } @@ -291,35 +291,35 @@ export interface KeyedProcessor { } export interface LastGcStats { - max?: Common.StorageSize; - max_in_bytes?: Common.Bytes; - usage_percent?: number; - used?: Common.StorageSize; - used_in_bytes?: Common.Bytes; + max?: Common.HumanReadableByteCount; + max_in_bytes?: Common.ByteCount; + usage_percent?: Common.PercentageNumber; + used?: Common.HumanReadableByteCount; + used_in_bytes?: Common.ByteCount; } export interface MemoryStats { - adjusted_total_in_bytes?: Common.Bytes; - free?: Common.StorageSize; - free_in_bytes?: Common.Bytes; - resident?: Common.StorageSize; - resident_in_bytes?: Common.Bytes; - share?: Common.StorageSize; - share_in_bytes?: Common.Bytes; - total?: Common.StorageSize; - total_in_bytes?: Common.Bytes; - total_virtual?: Common.StorageSize; - total_virtual_in_bytes?: Common.Bytes; - used?: Common.StorageSize; - used_in_bytes?: Common.Bytes; + adjusted_total_in_bytes?: Common.ByteCount; + free?: Common.HumanReadableByteCount; + free_in_bytes?: Common.ByteCount; + resident?: Common.HumanReadableByteCount; + resident_in_bytes?: Common.ByteCount; + share?: Common.HumanReadableByteCount; + share_in_bytes?: Common.ByteCount; + total?: Common.HumanReadableByteCount; + total_in_bytes?: Common.ByteCount; + total_virtual?: Common.HumanReadableByteCount; + total_virtual_in_bytes?: Common.ByteCount; + used?: Common.HumanReadableByteCount; + used_in_bytes?: Common.ByteCount; } export interface NodeBufferPool { count?: number; - total_capacity?: Common.StorageSize; - total_capacity_in_bytes?: Common.Bytes; - used?: Common.StorageSize; - used_in_bytes?: Common.Bytes; + total_capacity?: Common.HumanReadableByteCount; + total_capacity_in_bytes?: Common.ByteCount; + used?: Common.HumanReadableByteCount; + used_in_bytes?: Common.ByteCount; } export interface NodeReloadError { @@ -343,29 +343,29 @@ export interface OperatingSystem { export interface Pool { last_gc_stats?: LastGcStats; - max?: Common.StorageSize; - max_in_bytes?: Common.Bytes; - peak_max?: Common.StorageSize; - peak_max_in_bytes?: Common.Bytes; - peak_used?: Common.StorageSize; - peak_used_in_bytes?: Common.Bytes; - used?: Common.StorageSize; - used_in_bytes?: Common.Bytes; + max?: Common.HumanReadableByteCount; + max_in_bytes?: Common.ByteCount; + peak_max?: Common.HumanReadableByteCount; + peak_max_in_bytes?: Common.ByteCount; + peak_used?: Common.HumanReadableByteCount; + peak_used_in_bytes?: Common.ByteCount; + used?: Common.HumanReadableByteCount; + used_in_bytes?: Common.ByteCount; } export interface PressureMemory { - all?: Common.StorageSize; - all_in_bytes?: Common.Bytes; - combined_coordinating_and_primary?: Common.StorageSize; - combined_coordinating_and_primary_in_bytes?: Common.Bytes; - coordinating?: Common.StorageSize; - coordinating_in_bytes?: Common.Bytes; + all?: Common.HumanReadableByteCount; + all_in_bytes?: Common.ByteCount; + combined_coordinating_and_primary?: Common.HumanReadableByteCount; + combined_coordinating_and_primary_in_bytes?: Common.ByteCount; + coordinating?: Common.HumanReadableByteCount; + coordinating_in_bytes?: Common.ByteCount; coordinating_rejections?: number; - primary?: Common.StorageSize; - primary_in_bytes?: Common.Bytes; + primary?: Common.HumanReadableByteCount; + primary_in_bytes?: Common.ByteCount; primary_rejections?: number; - replica?: Common.StorageSize; - replica_in_bytes?: Common.Bytes; + replica?: Common.HumanReadableByteCount; + replica_in_bytes?: Common.ByteCount; replica_rejections?: number; } @@ -381,6 +381,7 @@ export interface Processor { count?: number; current?: number; failed?: number; + time?: Common.Duration; time_in_millis?: Common.DurationValueUnitMillis; } @@ -420,11 +421,11 @@ export interface SerializedClusterState { } export interface SerializedClusterStateDetail { - compressed_size?: Common.StorageSize; - compressed_size_in_bytes?: Common.Bytes; + compressed_size?: Common.HumanReadableByteCount; + compressed_size_in_bytes?: Common.ByteCount; count?: number; - uncompressed_size?: Common.StorageSize; - uncompressed_size_in_bytes?: Common.Bytes; + uncompressed_size?: Common.HumanReadableByteCount; + uncompressed_size_in_bytes?: Common.ByteCount; } export interface ShardAdmissionControlStats { @@ -439,8 +440,8 @@ export interface ShardCacheStats { hit_count?: number; item_count?: number; miss_count?: number; - size?: Common.StorageSize; - size_in_bytes?: Common.Bytes; + size?: Common.HumanReadableByteCount; + size_in_bytes?: Common.ByteCount; store_name?: string; } @@ -466,14 +467,14 @@ export type ShardRepositoriesStats = any[] export type ShardResourceUsageStats = Record export interface ShardResourceUsageStatsDetail { - cpu_utilization_percent?: Common.Percentage; + cpu_utilization_percent?: Common.PercentageString; io_usage_stats?: ShardResourceUsageStatsIoUsageStats; - memory_utilization_percent?: Common.Percentage; + memory_utilization_percent?: Common.PercentageString; timestamp?: number; } export interface ShardResourceUsageStatsIoUsageStats { - max_io_utilization_percent?: Common.Percentage; + max_io_utilization_percent?: Common.PercentageString; } export type ShardSearchBackpressureMode = 'disabled' | 'enforced' | 'monitor_only' @@ -487,7 +488,7 @@ export interface ShardSearchBackpressureStats { export interface ShardSearchBackpressureTaskCancellationStats { cancellation_count?: number; cancellation_limit_reached_count?: number; - cancelled_task_percentage?: number; + cancelled_task_percentage?: Common.PercentageNumber; current_cancellation_eligible_tasks_count?: number; } @@ -509,12 +510,12 @@ export interface ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerSta export interface ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats { cancellation_count?: number; - current_avg?: Common.StorageSize; - current_avg_bytes?: Common.Bytes; - current_max?: Common.StorageSize; - current_max_bytes?: Common.Bytes; - rolling_avg?: Common.StorageSize; - rolling_avg_bytes?: Common.Bytes; + current_avg?: Common.HumanReadableByteCount; + current_avg_bytes?: Common.ByteCount; + current_max?: Common.HumanReadableByteCount; + current_max_bytes?: Common.ByteCount; + rolling_avg?: Common.HumanReadableByteCount; + rolling_avg_bytes?: Common.ByteCount; } export interface ShardSearchBackpressureTaskResourceTrackerStats { @@ -621,13 +622,13 @@ export interface Transport { inbound_handling_time_histogram?: TransportHistogram[]; outbound_handling_time_histogram?: TransportHistogram[]; rx_count?: number; - rx_size?: Common.StorageSize; - rx_size_in_bytes?: Common.Bytes; + rx_size?: Common.HumanReadableByteCount; + rx_size_in_bytes?: Common.ByteCount; server_open?: number; total_outbound_connections?: number; tx_count?: number; - tx_size?: Common.StorageSize; - tx_size_in_bytes?: Common.Bytes; + tx_size?: Common.HumanReadableByteCount; + tx_size_in_bytes?: Common.ByteCount; } export interface TransportHistogram { diff --git a/api/_types/nodes.info.d.ts b/api/_types/nodes.info.d.ts index 2670776b0..a911dab20 100644 --- a/api/_types/nodes.info.d.ts +++ b/api/_types/nodes.info.d.ts @@ -46,7 +46,7 @@ export interface NodeInfo { settings?: NodeInfoSettings; thread_pool?: Record; total_indexing_buffer?: number; - total_indexing_buffer_in_bytes?: Common.Bytes; + total_indexing_buffer_in_bytes?: Common.ByteCount; transport?: NodeInfoTransport; transport_address?: Common.TransportAddress; version: Common.VersionString; @@ -75,8 +75,8 @@ export interface NodeInfoDiscovery { export interface NodeInfoHttp { bound_address: string[]; - max_content_length?: Common.StorageSize; - max_content_length_in_bytes: Common.Bytes; + max_content_length?: Common.HumanReadableByteCount; + max_content_length_in_bytes: Common.ByteCount; publish_address: string; } @@ -97,21 +97,21 @@ export interface NodeInfoIngestProcessor { } export interface NodeInfoJvmMemory { - direct_max?: Common.StorageSize; - direct_max_in_bytes: Common.Bytes; - heap_init?: Common.StorageSize; - heap_init_in_bytes: Common.Bytes; - heap_max?: Common.StorageSize; - heap_max_in_bytes: Common.Bytes; - non_heap_init?: Common.StorageSize; - non_heap_init_in_bytes: Common.Bytes; - non_heap_max?: Common.StorageSize; - non_heap_max_in_bytes: Common.Bytes; + direct_max?: Common.HumanReadableByteCount; + direct_max_in_bytes: Common.ByteCount; + heap_init?: Common.HumanReadableByteCount; + heap_init_in_bytes: Common.ByteCount; + heap_max?: Common.HumanReadableByteCount; + heap_max_in_bytes: Common.ByteCount; + non_heap_init?: Common.HumanReadableByteCount; + non_heap_init_in_bytes: Common.ByteCount; + non_heap_max?: Common.HumanReadableByteCount; + non_heap_max_in_bytes: Common.ByteCount; } export interface NodeInfoMemory { - total: Common.StorageSize; - total_in_bytes: Common.Bytes; + total: Common.HumanReadableByteCount; + total_in_bytes: Common.ByteCount; } export interface NodeInfoNetwork { @@ -126,8 +126,8 @@ export interface NodeInfoNetworkInterface { } export interface NodeInfoOSCPU { - cache_size: Common.StorageSize; - cache_size_in_bytes: Common.Bytes; + cache_size: Common.HumanReadableByteCount; + cache_size_in_bytes: Common.ByteCount; cores_per_socket: number; mhz: number; model: string; diff --git a/api/_types/snapshot._common.d.ts b/api/_types/snapshot._common.d.ts index 8a17bf2f9..514d44f06 100644 --- a/api/_types/snapshot._common.d.ts +++ b/api/_types/snapshot._common.d.ts @@ -18,14 +18,14 @@ import * as Common from './_common' export interface FileCountSnapshotStats { file_count: number; - size_in_bytes: Common.Bytes; + size_in_bytes: Common.ByteCount; } export interface IndexDetails { max_segments_per_shard: number; shard_count: number; - size?: Common.StorageSize; - size_in_bytes: Common.Bytes; + size?: Common.HumanReadableByteCount; + size_in_bytes: Common.ByteCount; } export interface InfoFeatureState { @@ -68,7 +68,7 @@ export interface ShardsStatsSummary { export interface ShardsStatsSummaryItem { file_count: number; - size_in_bytes: Common.Bytes; + size_in_bytes: Common.ByteCount; } export interface SnapshotIndexStats { diff --git a/api/_types/tasks._common.d.ts b/api/_types/tasks._common.d.ts index b7c73a7a4..0e4ca508c 100644 --- a/api/_types/tasks._common.d.ts +++ b/api/_types/tasks._common.d.ts @@ -18,18 +18,24 @@ import * as Common from './_common' export type GroupBy = 'nodes' | 'none' | 'parents' -export interface NodeTasks { - attributes?: Record; - host?: Common.Host; - ip?: Common.Ip; - name?: Common.NodeId; - roles?: string[]; +export interface PersistentTaskStatus { + state: string; +} + +export type RawTaskStatus = Record> + +export interface ReplicationTaskStatus { + phase: string; +} + +export type Status = ReplicationTaskStatus | Common.BulkByScrollTaskStatus | PersistentTaskStatus | RawTaskStatus + +export interface TaskExecutingNode extends Common.BaseNode { tasks: Record; - transport_address?: Common.TransportAddress; } -export interface ParentTaskInfo extends TaskInfo { - children?: TaskInfo[]; +export interface TaskGroup extends TaskInfo { + children?: TaskGroup[]; } export interface TaskInfo { @@ -44,16 +50,18 @@ export interface TaskInfo { running_time?: Common.Duration; running_time_in_nanos: Common.DurationValueUnitNanos; start_time_in_millis: Common.EpochTimeUnitMillis; - status?: Record; + status?: Status; type: string; } -export type TaskInfos = TaskInfo[] | Record +export type TaskInfos = TaskInfo[] | Record export interface TaskListResponseBase { node_failures?: Common.ErrorCause[]; - nodes?: Record; + nodes?: Record; task_failures?: Common.TaskFailure[]; tasks?: TaskInfos; } +export type TaskResponse = Common.BulkByScrollResponseBase + diff --git a/api/cat/allPitSegments.d.ts b/api/cat/allPitSegments.d.ts index cc82d52df..2ca8ec21a 100644 --- a/api/cat/allPitSegments.d.ts +++ b/api/cat/allPitSegments.d.ts @@ -20,7 +20,7 @@ import * as Common from '../_types/_common' import * as Cat_Common from '../_types/cat._common' export interface Cat_AllPitSegments_Request extends Global.Params { - bytes?: Common.StorageType; + bytes?: Common.ByteUnit; format?: string; h?: string[]; help?: boolean; diff --git a/api/cat/allocation.d.ts b/api/cat/allocation.d.ts index ad8c4113d..31e43a74e 100644 --- a/api/cat/allocation.d.ts +++ b/api/cat/allocation.d.ts @@ -20,7 +20,7 @@ import * as Common from '../_types/_common' import * as Cat_Allocation from '../_types/cat.allocation' export interface Cat_Allocation_Request extends Global.Params { - bytes?: Common.StorageType; + bytes?: Common.ByteUnit; cluster_manager_timeout?: Common.Duration; format?: string; h?: string[]; diff --git a/api/cat/fielddata.d.ts b/api/cat/fielddata.d.ts index e4685f999..4f2721422 100644 --- a/api/cat/fielddata.d.ts +++ b/api/cat/fielddata.d.ts @@ -20,7 +20,7 @@ import * as Common from '../_types/_common' import * as Cat_Fielddata from '../_types/cat.fielddata' export interface Cat_Fielddata_Request extends Global.Params { - bytes?: Common.StorageType; + bytes?: Common.ByteUnit; fields?: Common.Fields; format?: string; h?: string[]; diff --git a/api/cat/indices.d.ts b/api/cat/indices.d.ts index fa8300d6a..8f6c71ee5 100644 --- a/api/cat/indices.d.ts +++ b/api/cat/indices.d.ts @@ -20,7 +20,7 @@ import * as Common from '../_types/_common' import * as Cat_Indices from '../_types/cat.indices' export interface Cat_Indices_Request extends Global.Params { - bytes?: Common.StorageType; + bytes?: Common.ByteUnit; cluster_manager_timeout?: Common.Duration; expand_wildcards?: Common.ExpandWildcards; format?: string; diff --git a/api/cat/nodes.d.ts b/api/cat/nodes.d.ts index f00520104..8762a90fd 100644 --- a/api/cat/nodes.d.ts +++ b/api/cat/nodes.d.ts @@ -20,7 +20,7 @@ import * as Common from '../_types/_common' import * as Cat_Nodes from '../_types/cat.nodes' export interface Cat_Nodes_Request extends Global.Params { - bytes?: Common.StorageType; + bytes?: Common.ByteUnit; cluster_manager_timeout?: Common.Duration; format?: string; full_id?: boolean | string; diff --git a/api/cat/pitSegments.d.ts b/api/cat/pitSegments.d.ts index 2dfffbd51..d72926c0b 100644 --- a/api/cat/pitSegments.d.ts +++ b/api/cat/pitSegments.d.ts @@ -21,7 +21,7 @@ import * as Cat_Common from '../_types/cat._common' export interface Cat_PitSegments_Request extends Global.Params { body?: Cat_PitSegments_RequestBody; - bytes?: Common.StorageType; + bytes?: Common.ByteUnit; format?: string; h?: string[]; help?: boolean; diff --git a/api/cat/recovery.d.ts b/api/cat/recovery.d.ts index 179506999..616811a6a 100644 --- a/api/cat/recovery.d.ts +++ b/api/cat/recovery.d.ts @@ -21,7 +21,7 @@ import * as Cat_Recovery from '../_types/cat.recovery' export interface Cat_Recovery_Request extends Global.Params { active_only?: boolean; - bytes?: Common.StorageType; + bytes?: Common.ByteUnit; detailed?: boolean; format?: string; h?: string[]; diff --git a/api/cat/segmentReplication.d.ts b/api/cat/segmentReplication.d.ts index 4cc0adfef..0cf6fe533 100644 --- a/api/cat/segmentReplication.d.ts +++ b/api/cat/segmentReplication.d.ts @@ -22,7 +22,7 @@ import * as Cat_Common from '../_types/cat._common' export interface Cat_SegmentReplication_Request extends Global.Params { active_only?: boolean; allow_no_indices?: boolean; - bytes?: Common.StorageType; + bytes?: Common.ByteUnit; completed_only?: boolean; detailed?: boolean; expand_wildcards?: Common.ExpandWildcards; diff --git a/api/cat/segments.d.ts b/api/cat/segments.d.ts index 023cd8afc..f9b5fa97d 100644 --- a/api/cat/segments.d.ts +++ b/api/cat/segments.d.ts @@ -20,7 +20,7 @@ import * as Common from '../_types/_common' import * as Cat_Segments from '../_types/cat.segments' export interface Cat_Segments_Request extends Global.Params { - bytes?: Common.StorageType; + bytes?: Common.ByteUnit; cluster_manager_timeout?: Common.Duration; format?: string; h?: string[]; diff --git a/api/cat/shards.d.ts b/api/cat/shards.d.ts index dcf6d9700..0243440ae 100644 --- a/api/cat/shards.d.ts +++ b/api/cat/shards.d.ts @@ -20,7 +20,7 @@ import * as Common from '../_types/_common' import * as Cat_Shards from '../_types/cat.shards' export interface Cat_Shards_Request extends Global.Params { - bytes?: Common.StorageType; + bytes?: Common.ByteUnit; cluster_manager_timeout?: Common.Duration; format?: string; h?: string[]; diff --git a/api/cluster/reroute.d.ts b/api/cluster/reroute.d.ts index 26ac81953..89825c745 100644 --- a/api/cluster/reroute.d.ts +++ b/api/cluster/reroute.d.ts @@ -25,7 +25,7 @@ export interface Cluster_Reroute_Request extends Global.Params { dry_run?: boolean; explain?: boolean; master_timeout?: Common.Duration; - metric?: Common.Metrics; + metric?: Cluster_Reroute.Metric | Cluster_Reroute.Metric[]; retry_failed?: boolean; timeout?: Common.Duration; } diff --git a/api/flowFramework/_api.js b/api/flowFramework/_api.js index 887e3811f..2900e46b2 100644 --- a/api/flowFramework/_api.js +++ b/api/flowFramework/_api.js @@ -21,9 +21,21 @@ function FlowFrameworkApi(bindObj) { this.create = require('./create').bind(bindObj); this.delete = require('./delete').bind(bindObj); + this.deprovision = require('./deprovision').bind(bindObj); this.get = require('./get').bind(bindObj); + this.getStatus = require('./getStatus').bind(bindObj); + this.getSteps = require('./getSteps').bind(bindObj); + this.provision = require('./provision').bind(bindObj); + this.search = require('./search').bind(bindObj); + this.searchState = require('./searchState').bind(bindObj); this.update = require('./update').bind(bindObj); + // Deprecated: Use getStatus instead. + this.get_status = require('./getStatus').bind(bindObj); + // Deprecated: Use getSteps instead. + this.get_steps = require('./getSteps').bind(bindObj); + // Deprecated: Use searchState instead. + this.search_state = require('./searchState').bind(bindObj); } module.exports = FlowFrameworkApi; diff --git a/api/flowFramework/create.d.ts b/api/flowFramework/create.d.ts index bb04e63b1..c4ba24439 100644 --- a/api/flowFramework/create.d.ts +++ b/api/flowFramework/create.d.ts @@ -20,10 +20,11 @@ import * as FlowFramework_Common from '../_types/flow_framework.common' export interface FlowFramework_Create_Request extends Global.Params { body?: FlowFramework_Common.FlowFrameworkCreate; - provision?: boolean; - reprovision?: boolean; - use_case?: string; - validation?: string; + provision?: FlowFramework_Common.Provision; + reprovision?: FlowFramework_Common.Reprovision; + update_fields?: FlowFramework_Common.UpdateFields; + use_case?: FlowFramework_Common.UseCase; + validation?: FlowFramework_Common.Validation; } export interface FlowFramework_Create_Response extends ApiResponse { diff --git a/api/flowFramework/create.js b/api/flowFramework/create.js index 618bed821..a01550abb 100644 --- a/api/flowFramework/create.js +++ b/api/flowFramework/create.js @@ -25,8 +25,9 @@ const { normalizeArguments } = require('../utils'); * @memberOf API-Flow-Framework * * @param {object} [params] - * @param {boolean} [params.provision=false] - Provision the workflow as part of the request + * @param {boolean} [params.provision=false] - Provision the workflow as part of the request. * @param {boolean} [params.reprovision=false] + * @param {boolean} [params.update_fields=false] - Update only the fields included in the request body. * @param {string} [params.use_case] - To use a workflow template, specify it in the use_case query parameter when creating a workflow. * @param {string} [params.validation=all] - Validate the workflow. Valid values are all (validate the template) and none (do not validate the template). Default is all. * @param {object} [params.body] diff --git a/api/flowFramework/delete.d.ts b/api/flowFramework/delete.d.ts index 19cc3db5b..2abf88e86 100644 --- a/api/flowFramework/delete.d.ts +++ b/api/flowFramework/delete.d.ts @@ -16,10 +16,11 @@ import { ApiResponse } from '../../lib/Transport' import * as Global from '../_types/_global' +import * as FlowFramework_Common from '../_types/flow_framework.common' export interface FlowFramework_Delete_Request extends Global.Params { clear_status?: boolean; - workflow_id: string; + workflow_id: FlowFramework_Common.WorkflowID; } export interface FlowFramework_Delete_Response extends ApiResponse { diff --git a/api/flowFramework/deprovision.d.ts b/api/flowFramework/deprovision.d.ts new file mode 100644 index 000000000..91d5b01eb --- /dev/null +++ b/api/flowFramework/deprovision.d.ts @@ -0,0 +1,31 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as FlowFramework_Common from '../_types/flow_framework.common' + +export interface FlowFramework_Deprovision_Request extends Global.Params { + allow_delete?: FlowFramework_Common.AllowDelete; + workflow_id: FlowFramework_Common.WorkflowID; +} + +export interface FlowFramework_Deprovision_Response extends ApiResponse { + body: FlowFramework_Deprovision_ResponseBody; +} + +export type FlowFramework_Deprovision_ResponseBody = Record + diff --git a/api/flowFramework/deprovision.js b/api/flowFramework/deprovision.js new file mode 100644 index 000000000..8ffbd5a94 --- /dev/null +++ b/api/flowFramework/deprovision.js @@ -0,0 +1,50 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Deprovision workflow's resources when you no longer need it. + *
See Also: {@link https://opensearch.org/docs/latest/automating-configurations/api/deprovision-workflow/ - flow_framework.deprovision} + * + * @memberOf API-Flow-Framework + * + * @param {object} params + * @param {string} [params.allow_delete] - Required when deleting resources involves a high potential for data loss. + * @param {string} params.workflow_id + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function deprovisionFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.workflow_id == null) return handleMissingParam('workflow_id', this, callback); + + let { body, workflow_id, ...querystring } = params; + workflow_id = parsePathParam(workflow_id); + + const path = '/_plugins/_flow_framework/workflow/' + workflow_id + '/_deprovision'; + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = deprovisionFunc; diff --git a/api/flowFramework/get.d.ts b/api/flowFramework/get.d.ts index 56c13c379..f0434915c 100644 --- a/api/flowFramework/get.d.ts +++ b/api/flowFramework/get.d.ts @@ -16,9 +16,10 @@ import { ApiResponse } from '../../lib/Transport' import * as Global from '../_types/_global' +import * as FlowFramework_Common from '../_types/flow_framework.common' export interface FlowFramework_Get_Request extends Global.Params { - workflow_id: string; + workflow_id: FlowFramework_Common.WorkflowID; } export interface FlowFramework_Get_Response extends ApiResponse { diff --git a/api/flowFramework/getStatus.d.ts b/api/flowFramework/getStatus.d.ts new file mode 100644 index 000000000..5ec626367 --- /dev/null +++ b/api/flowFramework/getStatus.d.ts @@ -0,0 +1,31 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as FlowFramework_Common from '../_types/flow_framework.common' + +export interface FlowFramework_GetStatus_Request extends Global.Params { + all?: FlowFramework_Common.All; + workflow_id: FlowFramework_Common.WorkflowID; +} + +export interface FlowFramework_GetStatus_Response extends ApiResponse { + body: FlowFramework_GetStatus_ResponseBody; +} + +export type FlowFramework_GetStatus_ResponseBody = Record + diff --git a/api/flowFramework/getStatus.js b/api/flowFramework/getStatus.js new file mode 100644 index 000000000..4cc8c7d48 --- /dev/null +++ b/api/flowFramework/getStatus.js @@ -0,0 +1,50 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Get the provisioning deployment status until it is complete. + *
See Also: {@link https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-status/ - flow_framework.get_status} + * + * @memberOf API-Flow-Framework + * + * @param {object} params + * @param {boolean} [params.all=false] - The all parameter specifies whether the response should return all fields. + * @param {string} params.workflow_id + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function getStatusFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.workflow_id == null) return handleMissingParam('workflow_id', this, callback); + + let { body, workflow_id, ...querystring } = params; + workflow_id = parsePathParam(workflow_id); + + const path = '/_plugins/_flow_framework/workflow/' + workflow_id + '/_status'; + const method = 'GET'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = getStatusFunc; diff --git a/api/flowFramework/getSteps.d.ts b/api/flowFramework/getSteps.d.ts new file mode 100644 index 000000000..02af8b080 --- /dev/null +++ b/api/flowFramework/getSteps.d.ts @@ -0,0 +1,30 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as FlowFramework_Common from '../_types/flow_framework.common' + +export interface FlowFramework_GetSteps_Request extends Global.Params { + workflow_step?: FlowFramework_Common.WorkflowStepName; +} + +export interface FlowFramework_GetSteps_Response extends ApiResponse { + body: FlowFramework_GetSteps_ResponseBody; +} + +export type FlowFramework_GetSteps_ResponseBody = Record + diff --git a/api/flowFramework/getSteps.js b/api/flowFramework/getSteps.js new file mode 100644 index 000000000..d4eb39711 --- /dev/null +++ b/api/flowFramework/getSteps.js @@ -0,0 +1,47 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments } = require('../utils'); + +/** + * Get a list of workflow steps. + *
See Also: {@link https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-steps/ - flow_framework.get_steps} + * + * @memberOf API-Flow-Framework + * + * @param {object} [params] + * @param {string} [params.workflow_step] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function getStepsFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, ...querystring } = params; + + const path = '/_plugins/_flow_framework/workflow/_steps'; + const method = 'GET'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = getStepsFunc; diff --git a/api/flowFramework/provision.d.ts b/api/flowFramework/provision.d.ts new file mode 100644 index 000000000..8be65e34f --- /dev/null +++ b/api/flowFramework/provision.d.ts @@ -0,0 +1,31 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as FlowFramework_Common from '../_types/flow_framework.common' + +export interface FlowFramework_Provision_Request extends Global.Params { + body?: FlowFramework_Common.UserProvidedSubstitutionExpressions; + workflow_id: FlowFramework_Common.WorkflowID; +} + +export interface FlowFramework_Provision_Response extends ApiResponse { + body: FlowFramework_Provision_ResponseBody; +} + +export type FlowFramework_Provision_ResponseBody = Record + diff --git a/api/flowFramework/provision.js b/api/flowFramework/provision.js new file mode 100644 index 000000000..9e939533a --- /dev/null +++ b/api/flowFramework/provision.js @@ -0,0 +1,50 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Provisioning a workflow. This API is also executed when the Create or Update Workflow API is called with the provision parameter set to true. + *
See Also: {@link https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/ - flow_framework.provision} + * + * @memberOf API-Flow-Framework + * + * @param {object} params + * @param {string} params.workflow_id + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function provisionFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.workflow_id == null) return handleMissingParam('workflow_id', this, callback); + + let { body, workflow_id, ...querystring } = params; + workflow_id = parsePathParam(workflow_id); + + const path = '/_plugins/_flow_framework/workflow/' + workflow_id + '/_provision'; + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = provisionFunc; diff --git a/api/flowFramework/search.d.ts b/api/flowFramework/search.d.ts new file mode 100644 index 000000000..2276345bf --- /dev/null +++ b/api/flowFramework/search.d.ts @@ -0,0 +1,30 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as FlowFramework_Common from '../_types/flow_framework.common' + +export interface FlowFramework_Search_Request extends Global.Params { + body: FlowFramework_Common.SearchWorkflowRequest; +} + +export interface FlowFramework_Search_Response extends ApiResponse { + body: FlowFramework_Search_ResponseBody; +} + +export type FlowFramework_Search_ResponseBody = Record + diff --git a/api/flowFramework/search.js b/api/flowFramework/search.js new file mode 100644 index 000000000..5e038f9b0 --- /dev/null +++ b/api/flowFramework/search.js @@ -0,0 +1,47 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, handleMissingParam } = require('../utils'); + +/** + * Search for workflows by using a query matching a field. + *
See Also: {@link https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/ - flow_framework.search} + * + * @memberOf API-Flow-Framework + * + * @param {object} params + * @param {object} params.body + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function searchFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.body == null) return handleMissingParam('body', this, callback); + + let { body, ...querystring } = params; + + const path = '/_plugins/_flow_framework/workflow/_search'; + const method = body ? 'POST' : 'GET'; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = searchFunc; diff --git a/api/flowFramework/searchState.d.ts b/api/flowFramework/searchState.d.ts new file mode 100644 index 000000000..3ee202338 --- /dev/null +++ b/api/flowFramework/searchState.d.ts @@ -0,0 +1,30 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as FlowFramework_Common from '../_types/flow_framework.common' + +export interface FlowFramework_SearchState_Request extends Global.Params { + body: FlowFramework_Common.SearchWorkflowRequest; +} + +export interface FlowFramework_SearchState_Response extends ApiResponse { + body: FlowFramework_SearchState_ResponseBody; +} + +export type FlowFramework_SearchState_ResponseBody = Record + diff --git a/api/flowFramework/searchState.js b/api/flowFramework/searchState.js new file mode 100644 index 000000000..1dce20851 --- /dev/null +++ b/api/flowFramework/searchState.js @@ -0,0 +1,47 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, handleMissingParam } = require('../utils'); + +/** + * Search for workflows by using a query matching a field. + *
See Also: {@link https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/ - flow_framework.search_state} + * + * @memberOf API-Flow-Framework + * + * @param {object} params + * @param {object} params.body + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function searchStateFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.body == null) return handleMissingParam('body', this, callback); + + let { body, ...querystring } = params; + + const path = '/_plugins/_flow_framework/workflow/state/_search'; + const method = body ? 'POST' : 'GET'; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = searchStateFunc; diff --git a/api/flowFramework/update.d.ts b/api/flowFramework/update.d.ts index 2babf31d6..a129fcd41 100644 --- a/api/flowFramework/update.d.ts +++ b/api/flowFramework/update.d.ts @@ -20,8 +20,12 @@ import * as FlowFramework_Common from '../_types/flow_framework.common' export interface FlowFramework_Update_Request extends Global.Params { body?: FlowFramework_Common.FlowFrameworkUpdate; - update_fields?: boolean; - workflow_id: string; + provision?: FlowFramework_Common.Provision; + reprovision?: FlowFramework_Common.Reprovision; + update_fields?: FlowFramework_Common.UpdateFields; + use_case?: FlowFramework_Common.UseCase; + validation?: FlowFramework_Common.Validation; + workflow_id: FlowFramework_Common.WorkflowID; } export interface FlowFramework_Update_Response extends ApiResponse { diff --git a/api/flowFramework/update.js b/api/flowFramework/update.js index 0408b1af6..b330826b9 100644 --- a/api/flowFramework/update.js +++ b/api/flowFramework/update.js @@ -25,7 +25,11 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Flow-Framework * * @param {object} params + * @param {boolean} [params.provision=false] - Provision the workflow as part of the request. + * @param {boolean} [params.reprovision=false] * @param {boolean} [params.update_fields=false] - Update only the fields included in the request body. + * @param {string} [params.use_case] - To use a workflow template, specify it in the use_case query parameter when creating a workflow. + * @param {string} [params.validation=all] - Validate the workflow. Valid values are all (validate the template) and none (do not validate the template). Default is all. * @param {string} params.workflow_id * @param {object} [params.body] * diff --git a/api/index.d.ts b/api/index.d.ts index c1473992d..b28c15357 100644 --- a/api/index.d.ts +++ b/api/index.d.ts @@ -229,6 +229,7 @@ import { Security_GetUsersLegacy_Request, Security_GetUsersLegacy_Response, Secu import { Security_DeleteUserLegacy_Request, Security_DeleteUserLegacy_Response, Security_DeleteUserLegacy_ResponseBody } from './security/deleteUserLegacy'; import { Security_GetUserLegacy_Request, Security_GetUserLegacy_Response, Security_GetUserLegacy_ResponseBody } from './security/getUserLegacy'; import { Security_CreateUserLegacy_Request, Security_CreateUserLegacy_Response, Security_CreateUserLegacy_ResponseBody } from './security/createUserLegacy'; +import { Security_GenerateUserTokenLegacy_Request, Security_GenerateUserTokenLegacy_Response, Security_GenerateUserTokenLegacy_ResponseBody } from './security/generateUserTokenLegacy'; import { Security_Validate_Request, Security_Validate_Response, Security_Validate_ResponseBody } from './security/validate'; import { Security_Authinfo_Request, Security_Authinfo_Response, Security_Authinfo_ResponseBody } from './security/authinfo'; import { Security_GetDashboardsInfo_Request, Security_GetDashboardsInfo_Response, Security_GetDashboardsInfo_ResponseBody } from './security/getDashboardsInfo'; @@ -242,15 +243,37 @@ import { AsynchronousSearch_Delete_Request, AsynchronousSearch_Delete_Response, import { AsynchronousSearch_Get_Request, AsynchronousSearch_Get_Response, AsynchronousSearch_Get_ResponseBody } from './asynchronousSearch/get'; import { AsynchronousSearch_Stats_Request, AsynchronousSearch_Stats_Response, AsynchronousSearch_Stats_ResponseBody } from './asynchronousSearch/stats'; import { FlowFramework_Create_Request, FlowFramework_Create_Response, FlowFramework_Create_ResponseBody } from './flowFramework/create'; +import { FlowFramework_Search_Request, FlowFramework_Search_Response, FlowFramework_Search_ResponseBody } from './flowFramework/search'; +import { FlowFramework_GetSteps_Request, FlowFramework_GetSteps_Response, FlowFramework_GetSteps_ResponseBody } from './flowFramework/getSteps'; import { FlowFramework_Delete_Request, FlowFramework_Delete_Response, FlowFramework_Delete_ResponseBody } from './flowFramework/delete'; import { FlowFramework_Get_Request, FlowFramework_Get_Response, FlowFramework_Get_ResponseBody } from './flowFramework/get'; import { FlowFramework_Update_Request, FlowFramework_Update_Response, FlowFramework_Update_ResponseBody } from './flowFramework/update'; +import { FlowFramework_Deprovision_Request, FlowFramework_Deprovision_Response, FlowFramework_Deprovision_ResponseBody } from './flowFramework/deprovision'; +import { FlowFramework_Provision_Request, FlowFramework_Provision_Response, FlowFramework_Provision_ResponseBody } from './flowFramework/provision'; +import { FlowFramework_GetStatus_Request, FlowFramework_GetStatus_Response, FlowFramework_GetStatus_ResponseBody } from './flowFramework/getStatus'; +import { FlowFramework_SearchState_Request, FlowFramework_SearchState_Response, FlowFramework_SearchState_ResponseBody } from './flowFramework/searchState'; +import { Ism_AddPolicy_Request, Ism_AddPolicy_Response, Ism_AddPolicy_ResponseBody } from './ism/addPolicy'; +import { Ism_ChangePolicy_Request, Ism_ChangePolicy_Response, Ism_ChangePolicy_ResponseBody } from './ism/changePolicy'; +import { Ism_ExplainPolicy_Request, Ism_ExplainPolicy_RequestBody, Ism_ExplainPolicy_Response, Ism_ExplainPolicy_ResponseBody } from './ism/explainPolicy'; +import { Ism_GetPolicies_Request, Ism_GetPolicies_Response, Ism_GetPolicies_ResponseBody } from './ism/getPolicies'; +import { Ism_PutPolicies_Request, Ism_PutPolicies_Response, Ism_PutPolicies_ResponseBody } from './ism/putPolicies'; +import { Ism_DeletePolicy_Request, Ism_DeletePolicy_Response, Ism_DeletePolicy_ResponseBody } from './ism/deletePolicy'; +import { Ism_GetPolicy_Request, Ism_GetPolicy_Response, Ism_GetPolicy_ResponseBody } from './ism/getPolicy'; +import { Ism_ExistsPolicy_Request, Ism_ExistsPolicy_Response, Ism_ExistsPolicy_ResponseBody } from './ism/existsPolicy'; +import { Ism_PutPolicy_Request, Ism_PutPolicy_Response, Ism_PutPolicy_ResponseBody } from './ism/putPolicy'; +import { Ism_RemovePolicy_Request, Ism_RemovePolicy_Response, Ism_RemovePolicy_ResponseBody } from './ism/removePolicy'; +import { Ism_RetryIndex_Request, Ism_RetryIndex_Response, Ism_RetryIndex_ResponseBody } from './ism/retryIndex'; +import { Ism_RefreshSearchAnalyzers_Request, Ism_RefreshSearchAnalyzers_Response, Ism_RefreshSearchAnalyzers_ResponseBody } from './ism/refreshSearchAnalyzers'; import { Knn_Stats_Request, Knn_Stats_Response, Knn_Stats_ResponseBody } from './knn/stats'; import { Knn_SearchModels_Request, Knn_SearchModels_RequestBody, Knn_SearchModels_Response, Knn_SearchModels_ResponseBody } from './knn/searchModels'; import { Knn_TrainModel_Request, Knn_TrainModel_RequestBody, Knn_TrainModel_Response, Knn_TrainModel_ResponseBody } from './knn/trainModel'; import { Knn_DeleteModel_Request, Knn_DeleteModel_Response, Knn_DeleteModel_ResponseBody } from './knn/deleteModel'; import { Knn_GetModel_Request, Knn_GetModel_Response, Knn_GetModel_ResponseBody } from './knn/getModel'; import { Knn_Warmup_Request, Knn_Warmup_Response, Knn_Warmup_ResponseBody } from './knn/warmup'; +import { Ml_RegisterAgents_Request, Ml_RegisterAgents_Response, Ml_RegisterAgents_ResponseBody } from './ml/registerAgents'; +import { Ml_DeleteAgent_Request, Ml_DeleteAgent_Response, Ml_DeleteAgent_ResponseBody } from './ml/deleteAgent'; +import { Ml_CreateConnector_Request, Ml_CreateConnector_Response, Ml_CreateConnector_ResponseBody } from './ml/createConnector'; +import { Ml_DeleteConnector_Request, Ml_DeleteConnector_Response, Ml_DeleteConnector_ResponseBody } from './ml/deleteConnector'; import { Ml_RegisterModelGroup_Request, Ml_RegisterModelGroup_RequestBody, Ml_RegisterModelGroup_Response, Ml_RegisterModelGroup_ResponseBody } from './ml/registerModelGroup'; import { Ml_DeleteModelGroup_Request, Ml_DeleteModelGroup_Response, Ml_DeleteModelGroup_ResponseBody } from './ml/deleteModelGroup'; import { Ml_GetModelGroup_Request, Ml_GetModelGroup_Response, Ml_GetModelGroup_ResponseBody } from './ml/getModelGroup'; @@ -299,7 +322,7 @@ import { Rollups_Explain_Request, Rollups_Explain_Response, Rollups_Explain_Resp import { Rollups_Start_Request, Rollups_Start_Response, Rollups_Start_ResponseBody } from './rollups/start'; import { Rollups_Stop_Request, Rollups_Stop_Response, Rollups_Stop_ResponseBody } from './rollups/stop'; import { Transforms_Search_Request, Transforms_Search_Response, Transforms_Search_ResponseBody } from './transforms/search'; -import { Transforms_Preview_Request, Transforms_Preview_Response, Transforms_Preview_ResponseBody } from './transforms/preview'; +import { Transforms_Preview_Request, Transforms_Preview_RequestBody, Transforms_Preview_Response, Transforms_Preview_ResponseBody } from './transforms/preview'; import { Transforms_Delete_Request, Transforms_Delete_Response, Transforms_Delete_ResponseBody } from './transforms/delete'; import { Transforms_Get_Request, Transforms_Get_Response, Transforms_Get_ResponseBody } from './transforms/get'; import { Transforms_Put_Request, Transforms_Put_Response, Transforms_Put_ResponseBody } from './transforms/put'; @@ -541,6 +564,7 @@ export { Security_DeleteUserLegacy_Request, Security_DeleteUserLegacy_Response, Security_DeleteUserLegacy_ResponseBody, Security_GetUserLegacy_Request, Security_GetUserLegacy_Response, Security_GetUserLegacy_ResponseBody, Security_CreateUserLegacy_Request, Security_CreateUserLegacy_Response, Security_CreateUserLegacy_ResponseBody, + Security_GenerateUserTokenLegacy_Request, Security_GenerateUserTokenLegacy_Response, Security_GenerateUserTokenLegacy_ResponseBody, Security_Validate_Request, Security_Validate_Response, Security_Validate_ResponseBody, Security_Authinfo_Request, Security_Authinfo_Response, Security_Authinfo_ResponseBody, Security_GetDashboardsInfo_Request, Security_GetDashboardsInfo_Response, Security_GetDashboardsInfo_ResponseBody, @@ -554,15 +578,37 @@ export { AsynchronousSearch_Get_Request, AsynchronousSearch_Get_Response, AsynchronousSearch_Get_ResponseBody, AsynchronousSearch_Stats_Request, AsynchronousSearch_Stats_Response, AsynchronousSearch_Stats_ResponseBody, FlowFramework_Create_Request, FlowFramework_Create_Response, FlowFramework_Create_ResponseBody, + FlowFramework_Search_Request, FlowFramework_Search_Response, FlowFramework_Search_ResponseBody, + FlowFramework_GetSteps_Request, FlowFramework_GetSteps_Response, FlowFramework_GetSteps_ResponseBody, FlowFramework_Delete_Request, FlowFramework_Delete_Response, FlowFramework_Delete_ResponseBody, FlowFramework_Get_Request, FlowFramework_Get_Response, FlowFramework_Get_ResponseBody, FlowFramework_Update_Request, FlowFramework_Update_Response, FlowFramework_Update_ResponseBody, + FlowFramework_Deprovision_Request, FlowFramework_Deprovision_Response, FlowFramework_Deprovision_ResponseBody, + FlowFramework_Provision_Request, FlowFramework_Provision_Response, FlowFramework_Provision_ResponseBody, + FlowFramework_GetStatus_Request, FlowFramework_GetStatus_Response, FlowFramework_GetStatus_ResponseBody, + FlowFramework_SearchState_Request, FlowFramework_SearchState_Response, FlowFramework_SearchState_ResponseBody, + Ism_AddPolicy_Request, Ism_AddPolicy_Response, Ism_AddPolicy_ResponseBody, + Ism_ChangePolicy_Request, Ism_ChangePolicy_Response, Ism_ChangePolicy_ResponseBody, + Ism_ExplainPolicy_Request, Ism_ExplainPolicy_RequestBody, Ism_ExplainPolicy_Response, Ism_ExplainPolicy_ResponseBody, + Ism_GetPolicies_Request, Ism_GetPolicies_Response, Ism_GetPolicies_ResponseBody, + Ism_PutPolicies_Request, Ism_PutPolicies_Response, Ism_PutPolicies_ResponseBody, + Ism_DeletePolicy_Request, Ism_DeletePolicy_Response, Ism_DeletePolicy_ResponseBody, + Ism_GetPolicy_Request, Ism_GetPolicy_Response, Ism_GetPolicy_ResponseBody, + Ism_ExistsPolicy_Request, Ism_ExistsPolicy_Response, Ism_ExistsPolicy_ResponseBody, + Ism_PutPolicy_Request, Ism_PutPolicy_Response, Ism_PutPolicy_ResponseBody, + Ism_RemovePolicy_Request, Ism_RemovePolicy_Response, Ism_RemovePolicy_ResponseBody, + Ism_RetryIndex_Request, Ism_RetryIndex_Response, Ism_RetryIndex_ResponseBody, + Ism_RefreshSearchAnalyzers_Request, Ism_RefreshSearchAnalyzers_Response, Ism_RefreshSearchAnalyzers_ResponseBody, Knn_Stats_Request, Knn_Stats_Response, Knn_Stats_ResponseBody, Knn_SearchModels_Request, Knn_SearchModels_RequestBody, Knn_SearchModels_Response, Knn_SearchModels_ResponseBody, Knn_TrainModel_Request, Knn_TrainModel_RequestBody, Knn_TrainModel_Response, Knn_TrainModel_ResponseBody, Knn_DeleteModel_Request, Knn_DeleteModel_Response, Knn_DeleteModel_ResponseBody, Knn_GetModel_Request, Knn_GetModel_Response, Knn_GetModel_ResponseBody, Knn_Warmup_Request, Knn_Warmup_Response, Knn_Warmup_ResponseBody, + Ml_RegisterAgents_Request, Ml_RegisterAgents_Response, Ml_RegisterAgents_ResponseBody, + Ml_DeleteAgent_Request, Ml_DeleteAgent_Response, Ml_DeleteAgent_ResponseBody, + Ml_CreateConnector_Request, Ml_CreateConnector_Response, Ml_CreateConnector_ResponseBody, + Ml_DeleteConnector_Request, Ml_DeleteConnector_Response, Ml_DeleteConnector_ResponseBody, Ml_RegisterModelGroup_Request, Ml_RegisterModelGroup_RequestBody, Ml_RegisterModelGroup_Response, Ml_RegisterModelGroup_ResponseBody, Ml_DeleteModelGroup_Request, Ml_DeleteModelGroup_Response, Ml_DeleteModelGroup_ResponseBody, Ml_GetModelGroup_Request, Ml_GetModelGroup_Response, Ml_GetModelGroup_ResponseBody, @@ -611,7 +657,7 @@ export { Rollups_Start_Request, Rollups_Start_Response, Rollups_Start_ResponseBody, Rollups_Stop_Request, Rollups_Stop_Response, Rollups_Stop_ResponseBody, Transforms_Search_Request, Transforms_Search_Response, Transforms_Search_ResponseBody, - Transforms_Preview_Request, Transforms_Preview_Response, Transforms_Preview_ResponseBody, + Transforms_Preview_Request, Transforms_Preview_RequestBody, Transforms_Preview_Response, Transforms_Preview_ResponseBody, Transforms_Delete_Request, Transforms_Delete_Response, Transforms_Delete_ResponseBody, Transforms_Get_Request, Transforms_Get_Response, Transforms_Get_ResponseBody, Transforms_Put_Request, Transforms_Put_Response, Transforms_Put_ResponseBody, diff --git a/api/indices/dataStreamsStats.d.ts b/api/indices/dataStreamsStats.d.ts index cfcea78dc..2df370610 100644 --- a/api/indices/dataStreamsStats.d.ts +++ b/api/indices/dataStreamsStats.d.ts @@ -32,7 +32,7 @@ export interface Indices_DataStreamsStats_ResponseBody { backing_indices: number; data_stream_count: number; data_streams: Indices_DataStreamsStats.DataStreamsStatsItem[]; - total_store_size_bytes: Common.Bytes; - total_store_sizes?: Common.StorageSize; + total_store_size_bytes: Common.ByteCount; + total_store_sizes?: Common.HumanReadableByteCount; } diff --git a/api/indices/shardStores.d.ts b/api/indices/shardStores.d.ts index 597cc3a57..9f92951bd 100644 --- a/api/indices/shardStores.d.ts +++ b/api/indices/shardStores.d.ts @@ -24,7 +24,7 @@ export interface Indices_ShardStores_Request extends Global.Params { expand_wildcards?: Common.ExpandWildcards; ignore_unavailable?: boolean; index?: Common.Indices; - status?: Indices_ShardStores.ShardStoreStatus | Indices_ShardStores.ShardStoreStatus[]; + status?: Indices_ShardStores.Status | Indices_ShardStores.Status[]; } export interface Indices_ShardStores_Response extends ApiResponse { diff --git a/api/indices/stats.d.ts b/api/indices/stats.d.ts index 27ce8cf22..ecc60c9f2 100644 --- a/api/indices/stats.d.ts +++ b/api/indices/stats.d.ts @@ -30,7 +30,7 @@ export interface Indices_Stats_Request extends Global.Params { include_unloaded_segments?: boolean; index?: Common.Indices; level?: Common.Level; - metric?: Common.Metrics; + metric?: Indices_Stats.Metric | Indices_Stats.Metric[]; } export interface Indices_Stats_Response extends ApiResponse { diff --git a/api/ism/_api.js b/api/ism/_api.js new file mode 100644 index 000000000..e1b3017ac --- /dev/null +++ b/api/ism/_api.js @@ -0,0 +1,61 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +/** @namespace API-Ism */ + +function IsmApi(bindObj) { + this.addPolicy = require('./addPolicy').bind(bindObj); + this.changePolicy = require('./changePolicy').bind(bindObj); + this.deletePolicy = require('./deletePolicy').bind(bindObj); + this.existsPolicy = require('./existsPolicy').bind(bindObj); + this.explainPolicy = require('./explainPolicy').bind(bindObj); + this.getPolicies = require('./getPolicies').bind(bindObj); + this.getPolicy = require('./getPolicy').bind(bindObj); + this.putPolicies = require('./putPolicies').bind(bindObj); + this.putPolicy = require('./putPolicy').bind(bindObj); + this.refreshSearchAnalyzers = require('./refreshSearchAnalyzers').bind(bindObj); + this.removePolicy = require('./removePolicy').bind(bindObj); + this.retryIndex = require('./retryIndex').bind(bindObj); + + // Deprecated: Use addPolicy instead. + this.add_policy = require('./addPolicy').bind(bindObj); + // Deprecated: Use changePolicy instead. + this.change_policy = require('./changePolicy').bind(bindObj); + // Deprecated: Use deletePolicy instead. + this.delete_policy = require('./deletePolicy').bind(bindObj); + // Deprecated: Use existsPolicy instead. + this.exists_policy = require('./existsPolicy').bind(bindObj); + // Deprecated: Use explainPolicy instead. + this.explain_policy = require('./explainPolicy').bind(bindObj); + // Deprecated: Use getPolicies instead. + this.get_policies = require('./getPolicies').bind(bindObj); + // Deprecated: Use getPolicy instead. + this.get_policy = require('./getPolicy').bind(bindObj); + // Deprecated: Use putPolicies instead. + this.put_policies = require('./putPolicies').bind(bindObj); + // Deprecated: Use putPolicy instead. + this.put_policy = require('./putPolicy').bind(bindObj); + // Deprecated: Use refreshSearchAnalyzers instead. + this.refresh_search_analyzers = require('./refreshSearchAnalyzers').bind(bindObj); + // Deprecated: Use removePolicy instead. + this.remove_policy = require('./removePolicy').bind(bindObj); + // Deprecated: Use retryIndex instead. + this.retry_index = require('./retryIndex').bind(bindObj); +} + +module.exports = IsmApi; diff --git a/api/ism/addPolicy.d.ts b/api/ism/addPolicy.d.ts new file mode 100644 index 000000000..43605661f --- /dev/null +++ b/api/ism/addPolicy.d.ts @@ -0,0 +1,32 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ism_Common from '../_types/ism._common' +import * as Common from '../_types/_common' + +export interface Ism_AddPolicy_Request extends Global.Params { + body?: Ism_Common.AddPolicyRequest; + index?: Common.IndexName; +} + +export interface Ism_AddPolicy_Response extends ApiResponse { + body: Ism_AddPolicy_ResponseBody; +} + +export type Ism_AddPolicy_ResponseBody = Ism_Common.AddPolicyResponse + diff --git a/api/ism/addPolicy.js b/api/ism/addPolicy.js new file mode 100644 index 000000000..c9b4505b9 --- /dev/null +++ b/api/ism/addPolicy.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam } = require('../utils'); + +/** + * Adds a policy to an index. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy - ism.add_policy} + * + * @memberOf API-Ism + * + * @param {object} [params] + * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function addPolicyFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, index, ...querystring } = params; + index = parsePathParam(index); + + const path = ['/_plugins/_ism/add/', index].filter(c => c).join('').replace('//', '/'); + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = addPolicyFunc; diff --git a/api/ism/changePolicy.d.ts b/api/ism/changePolicy.d.ts new file mode 100644 index 000000000..f2b564127 --- /dev/null +++ b/api/ism/changePolicy.d.ts @@ -0,0 +1,32 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ism_Common from '../_types/ism._common' +import * as Common from '../_types/_common' + +export interface Ism_ChangePolicy_Request extends Global.Params { + body?: Ism_Common.ChangePolicyRequest; + index?: Common.IndexName; +} + +export interface Ism_ChangePolicy_Response extends ApiResponse { + body: Ism_ChangePolicy_ResponseBody; +} + +export type Ism_ChangePolicy_ResponseBody = Ism_Common.ChangePolicyResponse + diff --git a/api/ism/changePolicy.js b/api/ism/changePolicy.js new file mode 100644 index 000000000..aa5026d7d --- /dev/null +++ b/api/ism/changePolicy.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam } = require('../utils'); + +/** + * Updates the managed index policy to a new policy. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy - ism.change_policy} + * + * @memberOf API-Ism + * + * @param {object} [params] + * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function changePolicyFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, index, ...querystring } = params; + index = parsePathParam(index); + + const path = ['/_plugins/_ism/change_policy/', index].filter(c => c).join('').replace('//', '/'); + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = changePolicyFunc; diff --git a/api/ism/deletePolicy.d.ts b/api/ism/deletePolicy.d.ts new file mode 100644 index 000000000..85658ceca --- /dev/null +++ b/api/ism/deletePolicy.d.ts @@ -0,0 +1,30 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ism_Common from '../_types/ism._common' + +export interface Ism_DeletePolicy_Request extends Global.Params { + policy_id: string; +} + +export interface Ism_DeletePolicy_Response extends ApiResponse { + body: Ism_DeletePolicy_ResponseBody; +} + +export type Ism_DeletePolicy_ResponseBody = Ism_Common.DeletePolicyResponse + diff --git a/api/ism/deletePolicy.js b/api/ism/deletePolicy.js new file mode 100644 index 000000000..b711d6f26 --- /dev/null +++ b/api/ism/deletePolicy.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Deletes a policy. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#delete-policy - ism.delete_policy} + * + * @memberOf API-Ism + * + * @param {object} params + * @param {string} params.policy_id + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function deletePolicyFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.policy_id == null) return handleMissingParam('policy_id', this, callback); + + let { body, policy_id, ...querystring } = params; + policy_id = parsePathParam(policy_id); + + const path = '/_plugins/_ism/policies/' + policy_id; + const method = 'DELETE'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = deletePolicyFunc; diff --git a/api/ism/existsPolicy.d.ts b/api/ism/existsPolicy.d.ts new file mode 100644 index 000000000..cf91ff54f --- /dev/null +++ b/api/ism/existsPolicy.d.ts @@ -0,0 +1,29 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' + +export interface Ism_ExistsPolicy_Request extends Global.Params { + policy_id: string; +} + +export interface Ism_ExistsPolicy_Response extends ApiResponse { + body: Ism_ExistsPolicy_ResponseBody; +} + +export type Ism_ExistsPolicy_ResponseBody = any + diff --git a/api/ism/existsPolicy.js b/api/ism/existsPolicy.js new file mode 100644 index 000000000..b272081f3 --- /dev/null +++ b/api/ism/existsPolicy.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Checks whether the policy exists. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy - ism.exists_policy} + * + * @memberOf API-Ism + * + * @param {object} params + * @param {string} params.policy_id + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function existsPolicyFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.policy_id == null) return handleMissingParam('policy_id', this, callback); + + let { body, policy_id, ...querystring } = params; + policy_id = parsePathParam(policy_id); + + const path = '/_plugins/_ism/policies/' + policy_id; + const method = 'HEAD'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = existsPolicyFunc; diff --git a/api/ism/explainPolicy.d.ts b/api/ism/explainPolicy.d.ts new file mode 100644 index 000000000..1d42930ea --- /dev/null +++ b/api/ism/explainPolicy.d.ts @@ -0,0 +1,34 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Common from '../_types/_common' +import * as Ism_Common from '../_types/ism._common' + +export interface Ism_ExplainPolicy_Request extends Global.Params { + body?: Ism_ExplainPolicy_RequestBody; + index?: Common.IndexName; +} + +export type Ism_ExplainPolicy_RequestBody = any + +export interface Ism_ExplainPolicy_Response extends ApiResponse { + body: Ism_ExplainPolicy_ResponseBody; +} + +export type Ism_ExplainPolicy_ResponseBody = Ism_Common.ExplainIndexResponse + diff --git a/api/ism/explainPolicy.js b/api/ism/explainPolicy.js new file mode 100644 index 000000000..1218c0da8 --- /dev/null +++ b/api/ism/explainPolicy.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam } = require('../utils'); + +/** + * Gets the currently applied policy on indices. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index - ism.explain_policy} + * + * @memberOf API-Ism + * + * @param {object} [params] + * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {string} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function explainPolicyFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, index, ...querystring } = params; + index = parsePathParam(index); + + const path = ['/_plugins/_ism/explain/', index].filter(c => c).join('').replace('//', '/'); + const method = body ? 'POST' : 'GET'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = explainPolicyFunc; diff --git a/api/ism/getPolicies.d.ts b/api/ism/getPolicies.d.ts new file mode 100644 index 000000000..82629f120 --- /dev/null +++ b/api/ism/getPolicies.d.ts @@ -0,0 +1,28 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ism_Common from '../_types/ism._common' + +export type Ism_GetPolicies_Request = Global.Params & Record + +export interface Ism_GetPolicies_Response extends ApiResponse { + body: Ism_GetPolicies_ResponseBody; +} + +export type Ism_GetPolicies_ResponseBody = Ism_Common.GetPoliciesResponse + diff --git a/api/ism/getPolicies.js b/api/ism/getPolicies.js new file mode 100644 index 000000000..377a0804e --- /dev/null +++ b/api/ism/getPolicies.js @@ -0,0 +1,45 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments } = require('../utils'); + +/** + * Gets the policies. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy - ism.get_policies} + * + * @memberOf API-Ism + * + * @param {object} [params] - (Unused) + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function getPoliciesFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, ...querystring } = params; + + const path = '/_plugins/_ism/policies'; + const method = 'GET'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = getPoliciesFunc; diff --git a/api/ism/getPolicy.d.ts b/api/ism/getPolicy.d.ts new file mode 100644 index 000000000..d5efb4141 --- /dev/null +++ b/api/ism/getPolicy.d.ts @@ -0,0 +1,30 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ism_Common from '../_types/ism._common' + +export interface Ism_GetPolicy_Request extends Global.Params { + policy_id: string; +} + +export interface Ism_GetPolicy_Response extends ApiResponse { + body: Ism_GetPolicy_ResponseBody; +} + +export type Ism_GetPolicy_ResponseBody = Ism_Common.GetPolicyResponse + diff --git a/api/ism/getPolicy.js b/api/ism/getPolicy.js new file mode 100644 index 000000000..b0ad17fdb --- /dev/null +++ b/api/ism/getPolicy.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Gets a policy. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#put-policy - ism.get_policy} + * + * @memberOf API-Ism + * + * @param {object} params + * @param {string} params.policy_id + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function getPolicyFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.policy_id == null) return handleMissingParam('policy_id', this, callback); + + let { body, policy_id, ...querystring } = params; + policy_id = parsePathParam(policy_id); + + const path = '/_plugins/_ism/policies/' + policy_id; + const method = 'GET'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = getPolicyFunc; diff --git a/api/ism/putPolicies.d.ts b/api/ism/putPolicies.d.ts new file mode 100644 index 000000000..f334a451e --- /dev/null +++ b/api/ism/putPolicies.d.ts @@ -0,0 +1,34 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ism_Common from '../_types/ism._common' +import * as Common from '../_types/_common' + +export interface Ism_PutPolicies_Request extends Global.Params { + body?: Ism_Common.PutPolicyRequest; + if_primary_term?: number; + if_seq_no?: Common.SequenceNumber; + policyID: string; +} + +export interface Ism_PutPolicies_Response extends ApiResponse { + body: Ism_PutPolicies_ResponseBody; +} + +export type Ism_PutPolicies_ResponseBody = Ism_Common.PutPolicyResponse + diff --git a/api/ism/putPolicies.js b/api/ism/putPolicies.js new file mode 100644 index 000000000..2de2ef3db --- /dev/null +++ b/api/ism/putPolicies.js @@ -0,0 +1,51 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, handleMissingParam } = require('../utils'); + +/** + * Gets the policies. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy - ism.put_policies} + * + * @memberOf API-Ism + * + * @param {object} params + * @param {number} [params.if_primary_term] - Only perform the operation if the document has this primary term. + * @param {number} [params.if_seq_no] - Only perform the operation if the document has this sequence number. + * @param {string} params.policyID + * @param {string} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function putPoliciesFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.policyID == null) return handleMissingParam('policyID', this, callback); + + let { body, ...querystring } = params; + + const path = '/_plugins/_ism/policies'; + const method = 'PUT'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = putPoliciesFunc; diff --git a/api/ism/putPolicy.d.ts b/api/ism/putPolicy.d.ts new file mode 100644 index 000000000..af6dc8a9b --- /dev/null +++ b/api/ism/putPolicy.d.ts @@ -0,0 +1,34 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ism_Common from '../_types/ism._common' +import * as Common from '../_types/_common' + +export interface Ism_PutPolicy_Request extends Global.Params { + body?: Ism_Common.PutPolicyRequest; + if_primary_term?: number; + if_seq_no?: Common.SequenceNumber; + policy_id: string; +} + +export interface Ism_PutPolicy_Response extends ApiResponse { + body: Ism_PutPolicy_ResponseBody; +} + +export type Ism_PutPolicy_ResponseBody = Ism_Common.PutPolicyResponse + diff --git a/api/ism/putPolicy.js b/api/ism/putPolicy.js new file mode 100644 index 000000000..01587d444 --- /dev/null +++ b/api/ism/putPolicy.js @@ -0,0 +1,52 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Creates or updates a policy. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy - ism.put_policy} + * + * @memberOf API-Ism + * + * @param {object} params + * @param {number} [params.if_primary_term] - Only perform the operation if the document has this primary term. + * @param {number} [params.if_seq_no] - Only perform the operation if the document has this sequence number. + * @param {string} params.policy_id + * @param {string} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function putPolicyFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.policy_id == null) return handleMissingParam('policy_id', this, callback); + + let { body, policy_id, ...querystring } = params; + policy_id = parsePathParam(policy_id); + + const path = '/_plugins/_ism/policies/' + policy_id; + const method = 'PUT'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = putPolicyFunc; diff --git a/api/ism/refreshSearchAnalyzers.d.ts b/api/ism/refreshSearchAnalyzers.d.ts new file mode 100644 index 000000000..4372c84ed --- /dev/null +++ b/api/ism/refreshSearchAnalyzers.d.ts @@ -0,0 +1,31 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Common from '../_types/_common' +import * as Ism_Common from '../_types/ism._common' + +export interface Ism_RefreshSearchAnalyzers_Request extends Global.Params { + index: Common.IndexName; +} + +export interface Ism_RefreshSearchAnalyzers_Response extends ApiResponse { + body: Ism_RefreshSearchAnalyzers_ResponseBody; +} + +export type Ism_RefreshSearchAnalyzers_ResponseBody = Ism_Common.RefreshSearchAnalyzersResponse + diff --git a/api/ism/refreshSearchAnalyzers.js b/api/ism/refreshSearchAnalyzers.js new file mode 100644 index 000000000..7874fe134 --- /dev/null +++ b/api/ism/refreshSearchAnalyzers.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Refresh search analyzers in real time. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/refresh-analyzer/ - ism.refresh_search_analyzers} + * + * @memberOf API-Ism + * + * @param {object} params + * @param {string} params.index - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function refreshSearchAnalyzersFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.index == null) return handleMissingParam('index', this, callback); + + let { body, index, ...querystring } = params; + index = parsePathParam(index); + + const path = '/_plugins/_refresh_search_analyzers/' + index; + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = refreshSearchAnalyzersFunc; diff --git a/api/ism/removePolicy.d.ts b/api/ism/removePolicy.d.ts new file mode 100644 index 000000000..7ff1c511b --- /dev/null +++ b/api/ism/removePolicy.d.ts @@ -0,0 +1,31 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Common from '../_types/_common' +import * as Ism_Common from '../_types/ism._common' + +export interface Ism_RemovePolicy_Request extends Global.Params { + index?: Common.IndexName; +} + +export interface Ism_RemovePolicy_Response extends ApiResponse { + body: Ism_RemovePolicy_ResponseBody; +} + +export type Ism_RemovePolicy_ResponseBody = Ism_Common.RemovePolicyResponse + diff --git a/api/ism/removePolicy.js b/api/ism/removePolicy.js new file mode 100644 index 000000000..d29f5dbc0 --- /dev/null +++ b/api/ism/removePolicy.js @@ -0,0 +1,48 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam } = require('../utils'); + +/** + * Removes a policy from an index. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy - ism.remove_policy} + * + * @memberOf API-Ism + * + * @param {object} [params] + * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function removePolicyFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, index, ...querystring } = params; + index = parsePathParam(index); + + const path = ['/_plugins/_ism/remove/', index].filter(c => c).join('').replace('//', '/'); + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = removePolicyFunc; diff --git a/api/ism/retryIndex.d.ts b/api/ism/retryIndex.d.ts new file mode 100644 index 000000000..f31700b55 --- /dev/null +++ b/api/ism/retryIndex.d.ts @@ -0,0 +1,32 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ism_Common from '../_types/ism._common' +import * as Common from '../_types/_common' + +export interface Ism_RetryIndex_Request extends Global.Params { + body?: Ism_Common.RetryIndexRequest; + index?: Common.IndexName; +} + +export interface Ism_RetryIndex_Response extends ApiResponse { + body: Ism_RetryIndex_ResponseBody; +} + +export type Ism_RetryIndex_ResponseBody = Ism_Common.RetryIndexResponse + diff --git a/api/ism/retryIndex.js b/api/ism/retryIndex.js new file mode 100644 index 000000000..4ead79c7d --- /dev/null +++ b/api/ism/retryIndex.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam } = require('../utils'); + +/** + * Retry the failed action for an index. + *
See Also: {@link https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index - ism.retry_index} + * + * @memberOf API-Ism + * + * @param {object} [params] + * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function retryIndexFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, index, ...querystring } = params; + index = parsePathParam(index); + + const path = ['/_plugins/_ism/retry/', index].filter(c => c).join('').replace('//', '/'); + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = retryIndexFunc; diff --git a/api/knn/searchModels.d.ts b/api/knn/searchModels.d.ts index 84151af89..70af4b1c8 100644 --- a/api/knn/searchModels.d.ts +++ b/api/knn/searchModels.d.ts @@ -45,7 +45,7 @@ export interface Knn_SearchModels_Request extends Global.Params { q?: string; request_cache?: boolean; rest_total_hits_as_int?: boolean; - routing?: string[]; + routing?: Common.Routing; scroll?: Common.Duration; search_type?: Knn_Common.SearchType; seq_no_primary_term?: boolean; diff --git a/api/knn/searchModels.js b/api/knn/searchModels.js index 023b903fe..411103a5a 100644 --- a/api/knn/searchModels.js +++ b/api/knn/searchModels.js @@ -49,7 +49,7 @@ const { normalizeArguments } = require('../utils'); * @param {string} [params.q] - Query in the Lucene query string syntax. * @param {boolean} [params.request_cache] - Specify if request cache should be used for this request or not, defaults to index level setting. * @param {boolean} [params.rest_total_hits_as_int=false] - Indicates whether hits.total should be rendered as an integer or an object in the rest search response. - * @param {array} [params.routing] - Comma-separated list of specific routing values. + * @param {string} [params.routing] - Comma-separated list of specific routing values. * @param {string} [params.scroll] - Specify how long a consistent view of the index should be maintained for scrolled search. * @param {string} [params.search_type] - Search operation type. * @param {boolean} [params.seq_no_primary_term] - Specify whether to return sequence number and primary term of the last modification of each hit. diff --git a/api/ml/_api.js b/api/ml/_api.js index 7ac3f3e4f..8b705a4f6 100644 --- a/api/ml/_api.js +++ b/api/ml/_api.js @@ -19,17 +19,27 @@ /** @namespace API-Ml */ function MlApi(bindObj) { + this.createConnector = require('./createConnector').bind(bindObj); + this.deleteAgent = require('./deleteAgent').bind(bindObj); + this.deleteConnector = require('./deleteConnector').bind(bindObj); this.deleteModel = require('./deleteModel').bind(bindObj); this.deleteModelGroup = require('./deleteModelGroup').bind(bindObj); this.deleteTask = require('./deleteTask').bind(bindObj); this.deployModel = require('./deployModel').bind(bindObj); this.getModelGroup = require('./getModelGroup').bind(bindObj); this.getTask = require('./getTask').bind(bindObj); + this.registerAgents = require('./registerAgents').bind(bindObj); this.registerModel = require('./registerModel').bind(bindObj); this.registerModelGroup = require('./registerModelGroup').bind(bindObj); this.searchModels = require('./searchModels').bind(bindObj); this.undeployModel = require('./undeployModel').bind(bindObj); + // Deprecated: Use createConnector instead. + this.create_connector = require('./createConnector').bind(bindObj); + // Deprecated: Use deleteAgent instead. + this.delete_agent = require('./deleteAgent').bind(bindObj); + // Deprecated: Use deleteConnector instead. + this.delete_connector = require('./deleteConnector').bind(bindObj); // Deprecated: Use deleteModel instead. this.delete_model = require('./deleteModel').bind(bindObj); // Deprecated: Use deleteModelGroup instead. @@ -42,6 +52,8 @@ function MlApi(bindObj) { this.get_model_group = require('./getModelGroup').bind(bindObj); // Deprecated: Use getTask instead. this.get_task = require('./getTask').bind(bindObj); + // Deprecated: Use registerAgents instead. + this.register_agents = require('./registerAgents').bind(bindObj); // Deprecated: Use registerModel instead. this.register_model = require('./registerModel').bind(bindObj); // Deprecated: Use registerModelGroup instead. diff --git a/api/ml/createConnector.d.ts b/api/ml/createConnector.d.ts new file mode 100644 index 000000000..f980036f9 --- /dev/null +++ b/api/ml/createConnector.d.ts @@ -0,0 +1,32 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ml_Common from '../_types/ml._common' + +export interface Ml_CreateConnector_Request extends Global.Params { + body?: Ml_Common.CreateConnectorRequest; +} + +export interface Ml_CreateConnector_Response extends ApiResponse { + body: Ml_CreateConnector_ResponseBody; +} + +export interface Ml_CreateConnector_ResponseBody { + connector_id?: string; +} + diff --git a/api/ml/createConnector.js b/api/ml/createConnector.js new file mode 100644 index 000000000..ae8c9186c --- /dev/null +++ b/api/ml/createConnector.js @@ -0,0 +1,47 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments } = require('../utils'); + +/** + * Creates a standalone connector. + *
See Also: {@link undefined - ml.create_connector} + * + * @memberOf API-Ml + * + * @param {object} [params] + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function createConnectorFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, ...querystring } = params; + + const path = '/_plugins/_ml/connectors/_create'; + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = createConnectorFunc; diff --git a/api/ml/deleteAgent.d.ts b/api/ml/deleteAgent.d.ts new file mode 100644 index 000000000..4a0114e30 --- /dev/null +++ b/api/ml/deleteAgent.d.ts @@ -0,0 +1,30 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Common from '../_types/_common' + +export interface Ml_DeleteAgent_Request extends Global.Params { + agent_id: string; +} + +export interface Ml_DeleteAgent_Response extends ApiResponse { + body: Ml_DeleteAgent_ResponseBody; +} + +export type Ml_DeleteAgent_ResponseBody = Common.WriteResponseBase + diff --git a/api/ml/deleteAgent.js b/api/ml/deleteAgent.js new file mode 100644 index 000000000..2159eb095 --- /dev/null +++ b/api/ml/deleteAgent.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Delete an agent. + *
See Also: {@link undefined - ml.delete_agent} + * + * @memberOf API-Ml + * + * @param {object} params + * @param {string} params.agent_id + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function deleteAgentFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.agent_id == null) return handleMissingParam('agent_id', this, callback); + + let { body, agent_id, ...querystring } = params; + agent_id = parsePathParam(agent_id); + + const path = '/_plugins/_ml/agents/' + agent_id; + const method = 'DELETE'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = deleteAgentFunc; diff --git a/api/ml/deleteConnector.d.ts b/api/ml/deleteConnector.d.ts new file mode 100644 index 000000000..375112c99 --- /dev/null +++ b/api/ml/deleteConnector.d.ts @@ -0,0 +1,30 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Common from '../_types/_common' + +export interface Ml_DeleteConnector_Request extends Global.Params { + connector_id: string; +} + +export interface Ml_DeleteConnector_Response extends ApiResponse { + body: Ml_DeleteConnector_ResponseBody; +} + +export type Ml_DeleteConnector_ResponseBody = Common.WriteResponseBase + diff --git a/api/ml/deleteConnector.js b/api/ml/deleteConnector.js new file mode 100644 index 000000000..92c97f3f5 --- /dev/null +++ b/api/ml/deleteConnector.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Deletes a standalone connector. + *
See Also: {@link undefined - ml.delete_connector} + * + * @memberOf API-Ml + * + * @param {object} params + * @param {string} params.connector_id + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function deleteConnectorFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.connector_id == null) return handleMissingParam('connector_id', this, callback); + + let { body, connector_id, ...querystring } = params; + connector_id = parsePathParam(connector_id); + + const path = '/_plugins/_ml/connectors/' + connector_id; + const method = 'DELETE'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = deleteConnectorFunc; diff --git a/api/ml/registerAgents.d.ts b/api/ml/registerAgents.d.ts new file mode 100644 index 000000000..0577cdd5f --- /dev/null +++ b/api/ml/registerAgents.d.ts @@ -0,0 +1,32 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' +import * as Ml_Common from '../_types/ml._common' + +export interface Ml_RegisterAgents_Request extends Global.Params { + body?: Ml_Common.RegisterAgentsRequest; +} + +export interface Ml_RegisterAgents_Response extends ApiResponse { + body: Ml_RegisterAgents_ResponseBody; +} + +export interface Ml_RegisterAgents_ResponseBody { + agent_id?: string; +} + diff --git a/api/ml/registerAgents.js b/api/ml/registerAgents.js new file mode 100644 index 000000000..3e32cb1b5 --- /dev/null +++ b/api/ml/registerAgents.js @@ -0,0 +1,47 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments } = require('../utils'); + +/** + * Register an agent. + *
See Also: {@link undefined - ml.register_agents} + * + * @memberOf API-Ml + * + * @param {object} [params] + * @param {object} [params.body] + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function registerAgentsFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + + let { body, ...querystring } = params; + + const path = '/_plugins/_ml/agents/_register'; + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = registerAgentsFunc; diff --git a/api/security/_api.js b/api/security/_api.js index dde793fae..3c1721a3f 100644 --- a/api/security/_api.js +++ b/api/security/_api.js @@ -42,6 +42,7 @@ function SecurityApi(bindObj) { this.flushCache = require('./flushCache').bind(bindObj); this.generateOboToken = require('./generateOboToken').bind(bindObj); this.generateUserToken = require('./generateUserToken').bind(bindObj); + this.generateUserTokenLegacy = require('./generateUserTokenLegacy').bind(bindObj); this.getAccountDetails = require('./getAccountDetails').bind(bindObj); this.getActionGroup = require('./getActionGroup').bind(bindObj); this.getActionGroups = require('./getActionGroups').bind(bindObj); @@ -137,6 +138,8 @@ function SecurityApi(bindObj) { this.generate_obo_token = require('./generateOboToken').bind(bindObj); // Deprecated: Use generateUserToken instead. this.generate_user_token = require('./generateUserToken').bind(bindObj); + // Deprecated: Use generateUserTokenLegacy instead. + this.generate_user_token_legacy = require('./generateUserTokenLegacy').bind(bindObj); // Deprecated: Use getAccountDetails instead. this.get_account_details = require('./getAccountDetails').bind(bindObj); // Deprecated: Use getActionGroup instead. diff --git a/api/security/generateUserTokenLegacy.d.ts b/api/security/generateUserTokenLegacy.d.ts new file mode 100644 index 000000000..53187dad7 --- /dev/null +++ b/api/security/generateUserTokenLegacy.d.ts @@ -0,0 +1,29 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +import { ApiResponse } from '../../lib/Transport' +import * as Global from '../_types/_global' + +export interface Security_GenerateUserTokenLegacy_Request extends Global.Params { + username: string; +} + +export interface Security_GenerateUserTokenLegacy_Response extends ApiResponse { + body: Security_GenerateUserTokenLegacy_ResponseBody; +} + +export type Security_GenerateUserTokenLegacy_ResponseBody = Record + diff --git a/api/security/generateUserTokenLegacy.js b/api/security/generateUserTokenLegacy.js new file mode 100644 index 000000000..6e002922a --- /dev/null +++ b/api/security/generateUserTokenLegacy.js @@ -0,0 +1,49 @@ +/* + * Copyright OpenSearch Contributors + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + * + */ + +/* + * This file was generated from the OpenSearch API Spec. Do NOT edit it + * manually. If you want to make changes, either update the spec or + * modify the API generator. + */ + +'use strict'; + +const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); + +/** + * Generates authorization token for the given user. Legacy API. Not Implemented. + *
See Also: {@link undefined - security.generate_user_token_legacy} + * + * @memberOf API-Security + * + * @param {object} params + * @param {string} params.username - The name of the user for whom an auth token is to be vended. + * + * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} + * @param {function} [callback] - Callback that handles errors and response + * + * @returns {{abort: function(), then: function(), catch: function()}|Promise|*} + */ +function generateUserTokenLegacyFunc(params, options, callback) { + [params, options, callback] = normalizeArguments(params, options, callback); + if (params.username == null) return handleMissingParam('username', this, callback); + + let { body, username, ...querystring } = params; + username = parsePathParam(username); + + const path = '/_plugins/_security/api/user/' + username + '/authtoken'; + const method = 'POST'; + body = body || ''; + + return this.transport.request({ method, path, querystring, body }, options, callback); +} + +module.exports = generateUserTokenLegacyFunc; diff --git a/api/tasks/get.d.ts b/api/tasks/get.d.ts index 9dea35643..d71a574a8 100644 --- a/api/tasks/get.d.ts +++ b/api/tasks/get.d.ts @@ -32,7 +32,7 @@ export interface Tasks_Get_Response extends ApiResponse { export interface Tasks_Get_ResponseBody { completed: boolean; error?: Common.ErrorCause; - response?: Record; + response?: Tasks_Common.TaskResponse; task: Tasks_Common.TaskInfo; } diff --git a/api/transforms/preview.d.ts b/api/transforms/preview.d.ts index 68ee16c4e..f56bd38e4 100644 --- a/api/transforms/preview.d.ts +++ b/api/transforms/preview.d.ts @@ -18,7 +18,13 @@ import { ApiResponse } from '../../lib/Transport' import * as Global from '../_types/_global' import * as Transforms_Common from '../_types/transforms._common' -export type Transforms_Preview_Request = Global.Params & Record +export interface Transforms_Preview_Request extends Global.Params { + body?: Transforms_Preview_RequestBody; +} + +export interface Transforms_Preview_RequestBody { + transform: Transforms_Common.Transform; +} export interface Transforms_Preview_Response extends ApiResponse { body: Transforms_Preview_ResponseBody; diff --git a/api/transforms/preview.js b/api/transforms/preview.js index 97b3a8d06..8a54e514f 100644 --- a/api/transforms/preview.js +++ b/api/transforms/preview.js @@ -24,7 +24,9 @@ const { normalizeArguments } = require('../utils'); * * @memberOf API-Transforms * - * @param {object} [params] - (Unused) + * @param {object} [params] + * @param {object} [params.body] + * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response * @@ -36,7 +38,7 @@ function previewFunc(params, options, callback) { let { body, ...querystring } = params; const path = '/_plugins/_transform/_preview'; - const method = 'GET'; + const method = 'POST'; body = body || ''; return this.transport.request({ method, path, querystring, body }, options, callback);