ESQL: Add query monitoring API

Author: GalLalouche

specification/esql/queries/GetQueryRequest.ts

@@ -0,0 +1,40 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RequestBase } from '@_types/Base'
+import { Id } from '@_types/common'
+
+/**
+ * Get a specific running ES|QL query information.
+ * Returns an object extended information about a running ES|QL query.
+ *
+ * @rest_spec_name esql.get_query
+ * @index_previleges monitor_esql
+ */
+export interface GetQueryRequest extends RequestBase {
+  urls: [
+    {
+      path: '/_query/queries/{query_task_id}'
+      methods: ['GET']
+    }
+  ]
+  path_parts: {
+    query_task_id: Id
+  }
+}

specification/esql/queries/GetQueryResponse.ts

@@ -0,0 +1,33 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { NodeId, TaskId } from '@_types/common'
+import { long } from '@_types/Numeric'
+
+export class GetQueryResponse {
+  body: {
+    id: long
+    node: NodeId
+    start_time_millis: long
+    running_time_nanos: long
+    query: string
+    coordinating_node: NodeId
+    data_nodes: NodeId[]
+  }
+}

specification/esql/queries/ListQueriesRequest.ts

@@ -0,0 +1,36 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RequestBase } from '@_types/Base'
+
+/**
+ * Get running ES|QL queries information.
+ * Returns an object containing IDs and other information about the running ES|QL queries.
+
+ * @rest_spec_name esql.list_queries
+ * @index_previleges monitor_esql
+ */
+export interface ListQueryRequest extends RequestBase {
+  urls: [
+    {
+      path: '/_query/queries'
+      methods: ['GET']
+    }
+  ]
+}

specification/esql/queries/ListQueriesResponse.ts

@@ -0,0 +1,33 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { NodeId, TaskId } from '@_types/common'
+import { long } from '@_types/Numeric'
+
+export class ListQueryResponse {
+  body: {
+    queries: Record<TaskId, {
+      id: long
+      node: NodeId
+      start_time_millis: long
+      running_time_nanos: long
+      query: string
+    }>
+  }
+}