@nutanix-scratch/aiops-js-client 4.0.3-alpha.2 → 4.2.2-beta.1

package/dist/lib/apis/stats-endpoints.d.ts

@@ -1,6 +1,6 @@
 /**
  * Stats service.
- * @version 4.0.3-alpha-2
+ * @version 4.2.2-beta-1
  * @class StatsApi
  */
 export class StatsApi {
@@ -19,86 +19,76 @@ export class StatsApi {
     constructor(apiClient?: any);
     apiClient: any;
     /**
+     * Get entity and metrics descriptors
      * Returns metadata information available for entity and metrics for given entities.
-     * Returns entity and metrics descriptors.
-     * @param { String } extId The UUID of a source.
+     * @param { String } sourceExtId The UUID of a source.
      * @param {Object} opts Optional parameters defined for the operation
-     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned.
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
 
-     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
 
-     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter result on cluster name karbon-ntnx1.0, filter '$filter=startswith(name, 'C')' would filter on cluster name starting with C.<br>
-     * The filter can be applied on the following fields:<br>
-     * - entityType<br>
-     * - metrics/name
+     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'.
      * @param {Object} args Additional Arguments
      * @return {Promise<EntityDescriptorListApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link EntityDescriptorListApiResponse } and HTTP response
      */
-    getEntityDescriptorsV4(extId: string, opts: {
+    getEntityDescriptorsV4(sourceExtId: string, opts: {
         $page: number;
         $limit: number;
         $filter: string;
     }, ...args: any): Promise<EntityDescriptorListApiResponse>;
     /**
-     * Returns a list of various attributes and metrics (time series data) that are available for a given entity type.
-     * Returns attribute/metric data for the selected entities.
+     * Get attribute/metric data for the selected entities
+     * Returns a list of attributes and metrics (time series data) that are available for a given entity type.
      * @param { String } sourceExtId The UUID of a source.
      * @param { String } extId The UUID of an entity type.
-     * @param {Object} opts Optional parameters defined for the operation
-     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned.
+     * @param { Date } $startTime The start time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, start time of 2022-04-23T01:23:45.678+09:00 would consider all stats starting at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html
 
-     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
+     * @param { Date } $endTime The end time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, end time of 2022-04-23T013:23:45.678+09:00 would consider all stats till 13:23:45 .678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html
 
-     * @param { String } opts.$startTime The start time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, start time of 2022-04-23T01:23:45.678+09:00 would consider all stats starting at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
 
-     * @param { String } opts.$endTime The end time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, end time of 2022-04-23T013:23:45.678+09:00 would consider all stats till 13:23:45 .678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
 
-     * @param { Number } opts.$samplingInterval The sampling interval in seconds at which statistical data should be collected For example, do you want performance statistics every 30 seconds? Every 60 seconds?
+     * @param { Number } opts.$samplingInterval The sampling interval in seconds at which statistical data should be collected. For example, if you want performance statistics every 30 seconds, then provide the value as 30.
 
-     * @param { DownSamplingOperator } opts.$statType
-     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter result on cluster name karbon-ntnx1.0, filter '$filter=startswith(name, 'C')' would filter on cluster name starting with C.<br>
-     * The filter can be applied on the following fields:<br>
-     * - extId<br>
-     * - metrics/name<br>
-     * - metrics/timeSeries/values/value
-     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in desc order.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - extId
+     * @param { DownSamplingOperator } opts.$statType The operator to use while performing down-sampling on stats data. Allowed values are SUM, MIN, MAX, AVG, COUNT and LAST.
+
+     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'.
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.
      * @param {Object} args Additional Arguments
      * @return {Promise<EntityListApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link EntityListApiResponse } and HTTP response
      */
-    getEntityMetricsV4(sourceExtId: string, extId: string, opts: {
+    getEntityMetricsV4(sourceExtId: string, extId: string, $startTime: Date, $endTime: Date, opts: {
         $page: number;
         $limit: number;
-        $startTime: string;
-        $endTime: string;
         $samplingInterval: number;
         $statType: DownSamplingOperator;
         $filter: string;
         $orderby: string;
     }, ...args: any): Promise<EntityListApiResponse>;
     /**
-     * Returns a list of available entity types and their UUIDs for a given source. These UUIDs can be used in other APIs to get entity metrics and descriptors.
-     * Returns a list of available entity types for a given source.
-     * @param { String } extId The UUID of a source.
+     * Get a list of available entity types for a given source
+     * Returns a list of available entity types and their UUIDs for a given source. These UUIDs can further be used for other APIs to retrieve entity metrics and descriptors.
+     * @param { String } sourceExtId The UUID of a source.
      * @param {Object} args Additional Arguments
      * @return {Promise<EntityTypeListApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link EntityTypeListApiResponse } and HTTP response
      */
-    getEntityTypesV4(extId: string, ...args: any): Promise<EntityTypeListApiResponse>;
+    getEntityTypesV4(sourceExtId: string, ...args: any): Promise<EntityTypeListApiResponse>;
     /**
-     * Returns a list of available sources and their UUIDs. These UUIDs can be used in other APIs to get entity types and their metrics.
-     * Returns a list of available sources.
+     * Get a list of available sources
+     * Returns a list of available sources and their UUIDs. These UUIDs can further be used for other APIs to retrieve entity types and their metrics.
      * @param {Object} args Additional Arguments
      * @return {Promise<SourceListApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link SourceListApiResponse } and HTTP response
      */
     getSourcesV4(...args: any): Promise<SourceListApiResponse>;
     #private;
 }
-import EntityDescriptorListApiResponse from "../models/aiops/v4/stats/EntityDescriptorListApiResponse";
+import EntityDescriptorListApiResponse from "../models/aiops/v4/config/EntityDescriptorListApiResponse";
 import DownSamplingOperator from "../models/common/v1/stats/DownSamplingOperator";
 import EntityListApiResponse from "../models/aiops/v4/stats/EntityListApiResponse";
-import EntityTypeListApiResponse from "../models/aiops/v4/stats/EntityTypeListApiResponse";
-import SourceListApiResponse from "../models/aiops/v4/stats/SourceListApiResponse";
+import EntityTypeListApiResponse from "../models/aiops/v4/config/EntityTypeListApiResponse";
+import SourceListApiResponse from "../models/aiops/v4/config/SourceListApiResponse";
 import { ApiClient } from "../ApiClient";