@kestra-io/kestra-sdk 0.24.0

package/dist/api/MetricsApi.js

@@ -0,0 +1,393 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _MetricAggregations = _interopRequireDefault(require("../model/MetricAggregations"));
+var _PagedResultsMetricEntry = _interopRequireDefault(require("../model/PagedResultsMetricEntry"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Kestra EE
+ * All API operations, except for Superadmin-only endpoints, require a tenant identifier in the HTTP path.<br/> Endpoints designated as Superadmin-only are not tenant-scoped.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+* Metrics service.
+* @module api/MetricsApi
+* @version v0.24.0
+*/
+var MetricsApi = exports["default"] = /*#__PURE__*/function () {
+  /**
+  * Constructs a new MetricsApi. 
+  * @alias module:api/MetricsApi
+  * @class
+  * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+  * default to {@link module:ApiClient#instance} if unspecified.
+  */
+  function MetricsApi(apiClient) {
+    _classCallCheck(this, MetricsApi);
+    this.apiClient = apiClient || _ApiClient["default"].instance;
+  }
+
+  /**
+   * Callback function to receive the result of the aggregateMetricsFromFlow operation.
+   * @callback module:api/MetricsApi~aggregateMetricsFromFlowCallback
+   * @param {String} error Error message, if any.
+   * @param {module:model/MetricAggregations} data The data returned by the service call.
+   * @param {String} response The complete HTTP response.
+   */
+
+  /**
+   * Get metrics aggregations for a specific flow
+   * @param {String} namespace The namespace
+   * @param {String} flowId The flow Id
+   * @param {String} metric The metric name
+   * @param {String} aggregation The type of aggregation: avg, sum, min or max
+   * @param {String} tenant 
+   * @param {Object} opts Optional parameters
+   * @param {Date} [startDate] The start datetime, default to now - 30 days
+   * @param {Date} [endDate] The end datetime, default to now
+   * @param {module:api/MetricsApi~aggregateMetricsFromFlowCallback} callback The callback function, accepting three arguments: error, data, response
+   * data is of type: {@link module:model/MetricAggregations}
+   */
+  return _createClass(MetricsApi, [{
+    key: "aggregateMetricsFromFlow",
+    value: function aggregateMetricsFromFlow(namespace, flowId, metric, aggregation, tenant, opts, callback) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'namespace' is set
+      if (namespace === undefined || namespace === null) {
+        throw new Error("Missing the required parameter 'namespace' when calling aggregateMetricsFromFlow");
+      }
+      // verify the required parameter 'flowId' is set
+      if (flowId === undefined || flowId === null) {
+        throw new Error("Missing the required parameter 'flowId' when calling aggregateMetricsFromFlow");
+      }
+      // verify the required parameter 'metric' is set
+      if (metric === undefined || metric === null) {
+        throw new Error("Missing the required parameter 'metric' when calling aggregateMetricsFromFlow");
+      }
+      // verify the required parameter 'aggregation' is set
+      if (aggregation === undefined || aggregation === null) {
+        throw new Error("Missing the required parameter 'aggregation' when calling aggregateMetricsFromFlow");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling aggregateMetricsFromFlow");
+      }
+      var pathParams = {
+        'namespace': namespace,
+        'flowId': flowId,
+        'metric': metric,
+        'tenant': tenant
+      };
+      var queryParams = {
+        'startDate': opts['startDate'],
+        'endDate': opts['endDate'],
+        'aggregation': aggregation
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _MetricAggregations["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/metrics/aggregates/{namespace}/{flowId}/{metric}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the aggregateMetricsFromTask operation.
+     * @callback module:api/MetricsApi~aggregateMetricsFromTaskCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MetricAggregations} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get metrics aggregations for a specific flow
+     * @param {String} namespace The namespace
+     * @param {String} flowId The flow Id
+     * @param {String} taskId The task Id
+     * @param {String} metric The metric name
+     * @param {String} aggregation The type of aggregation: avg, sum, min or max
+     * @param {String} tenant 
+     * @param {Object} opts Optional parameters
+     * @param {Date} [startDate] The start datetime, default to now - 30 days
+     * @param {Date} [endDate] The end datetime, default to now
+     * @param {module:api/MetricsApi~aggregateMetricsFromTaskCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MetricAggregations}
+     */
+  }, {
+    key: "aggregateMetricsFromTask",
+    value: function aggregateMetricsFromTask(namespace, flowId, taskId, metric, aggregation, tenant, opts, callback) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'namespace' is set
+      if (namespace === undefined || namespace === null) {
+        throw new Error("Missing the required parameter 'namespace' when calling aggregateMetricsFromTask");
+      }
+      // verify the required parameter 'flowId' is set
+      if (flowId === undefined || flowId === null) {
+        throw new Error("Missing the required parameter 'flowId' when calling aggregateMetricsFromTask");
+      }
+      // verify the required parameter 'taskId' is set
+      if (taskId === undefined || taskId === null) {
+        throw new Error("Missing the required parameter 'taskId' when calling aggregateMetricsFromTask");
+      }
+      // verify the required parameter 'metric' is set
+      if (metric === undefined || metric === null) {
+        throw new Error("Missing the required parameter 'metric' when calling aggregateMetricsFromTask");
+      }
+      // verify the required parameter 'aggregation' is set
+      if (aggregation === undefined || aggregation === null) {
+        throw new Error("Missing the required parameter 'aggregation' when calling aggregateMetricsFromTask");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling aggregateMetricsFromTask");
+      }
+      var pathParams = {
+        'namespace': namespace,
+        'flowId': flowId,
+        'taskId': taskId,
+        'metric': metric,
+        'tenant': tenant
+      };
+      var queryParams = {
+        'startDate': opts['startDate'],
+        'endDate': opts['endDate'],
+        'aggregation': aggregation
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _MetricAggregations["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/metrics/aggregates/{namespace}/{flowId}/{taskId}/{metric}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the listFlowMetrics operation.
+     * @callback module:api/MetricsApi~listFlowMetricsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<String>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get metrics names for a specific flow
+     * @param {String} namespace The namespace
+     * @param {String} flowId The flow Id
+     * @param {String} tenant 
+     * @param {module:api/MetricsApi~listFlowMetricsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<String>}
+     */
+  }, {
+    key: "listFlowMetrics",
+    value: function listFlowMetrics(namespace, flowId, tenant, callback) {
+      var postBody = null;
+      // verify the required parameter 'namespace' is set
+      if (namespace === undefined || namespace === null) {
+        throw new Error("Missing the required parameter 'namespace' when calling listFlowMetrics");
+      }
+      // verify the required parameter 'flowId' is set
+      if (flowId === undefined || flowId === null) {
+        throw new Error("Missing the required parameter 'flowId' when calling listFlowMetrics");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling listFlowMetrics");
+      }
+      var pathParams = {
+        'namespace': namespace,
+        'flowId': flowId,
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = ['String'];
+      return this.apiClient.callApi('/api/v1/{tenant}/metrics/names/{namespace}/{flowId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the listTaskMetrics operation.
+     * @callback module:api/MetricsApi~listTaskMetricsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<String>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get metrics names for a specific task in a flow
+     * @param {String} namespace The namespace
+     * @param {String} flowId The flow Id
+     * @param {String} taskId The task Id
+     * @param {String} tenant 
+     * @param {module:api/MetricsApi~listTaskMetricsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<String>}
+     */
+  }, {
+    key: "listTaskMetrics",
+    value: function listTaskMetrics(namespace, flowId, taskId, tenant, callback) {
+      var postBody = null;
+      // verify the required parameter 'namespace' is set
+      if (namespace === undefined || namespace === null) {
+        throw new Error("Missing the required parameter 'namespace' when calling listTaskMetrics");
+      }
+      // verify the required parameter 'flowId' is set
+      if (flowId === undefined || flowId === null) {
+        throw new Error("Missing the required parameter 'flowId' when calling listTaskMetrics");
+      }
+      // verify the required parameter 'taskId' is set
+      if (taskId === undefined || taskId === null) {
+        throw new Error("Missing the required parameter 'taskId' when calling listTaskMetrics");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling listTaskMetrics");
+      }
+      var pathParams = {
+        'namespace': namespace,
+        'flowId': flowId,
+        'taskId': taskId,
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = ['String'];
+      return this.apiClient.callApi('/api/v1/{tenant}/metrics/names/{namespace}/{flowId}/{taskId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the listTasksWithMetrics operation.
+     * @callback module:api/MetricsApi~listTasksWithMetricsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<String>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get tasks id that have metrics for a specific flow, include deleted or renamed tasks
+     * @param {String} namespace The namespace
+     * @param {String} flowId The flow Id
+     * @param {String} tenant 
+     * @param {module:api/MetricsApi~listTasksWithMetricsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<String>}
+     */
+  }, {
+    key: "listTasksWithMetrics",
+    value: function listTasksWithMetrics(namespace, flowId, tenant, callback) {
+      var postBody = null;
+      // verify the required parameter 'namespace' is set
+      if (namespace === undefined || namespace === null) {
+        throw new Error("Missing the required parameter 'namespace' when calling listTasksWithMetrics");
+      }
+      // verify the required parameter 'flowId' is set
+      if (flowId === undefined || flowId === null) {
+        throw new Error("Missing the required parameter 'flowId' when calling listTasksWithMetrics");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling listTasksWithMetrics");
+      }
+      var pathParams = {
+        'namespace': namespace,
+        'flowId': flowId,
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = ['String'];
+      return this.apiClient.callApi('/api/v1/{tenant}/metrics/tasks/{namespace}/{flowId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the searchByExecution operation.
+     * @callback module:api/MetricsApi~searchByExecutionCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/PagedResultsMetricEntry} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get metrics for a specific execution
+     * @param {Number} page The current page
+     * @param {Number} size The current page size
+     * @param {String} executionId The execution id
+     * @param {String} tenant 
+     * @param {Object} opts Optional parameters
+     * @param {Array.<String>} [sort] The sort of current page
+     * @param {String} [taskRunId] The taskrun id
+     * @param {String} [taskId] The task id
+     * @param {module:api/MetricsApi~searchByExecutionCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/PagedResultsMetricEntry}
+     */
+  }, {
+    key: "searchByExecution",
+    value: function searchByExecution(page, size, executionId, tenant, opts, callback) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'page' is set
+      if (page === undefined || page === null) {
+        throw new Error("Missing the required parameter 'page' when calling searchByExecution");
+      }
+      // verify the required parameter 'size' is set
+      if (size === undefined || size === null) {
+        throw new Error("Missing the required parameter 'size' when calling searchByExecution");
+      }
+      // verify the required parameter 'executionId' is set
+      if (executionId === undefined || executionId === null) {
+        throw new Error("Missing the required parameter 'executionId' when calling searchByExecution");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling searchByExecution");
+      }
+      var pathParams = {
+        'executionId': executionId,
+        'tenant': tenant
+      };
+      var queryParams = {
+        'page': page,
+        'size': size,
+        'sort': this.apiClient.buildCollectionParam(opts['sort'], 'csv'),
+        'taskRunId': opts['taskRunId'],
+        'taskId': opts['taskId']
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _PagedResultsMetricEntry["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/metrics/{executionId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+  }]);
+}();