@openshift-migration-advisor/planner-sdk 0.13.7 → 0.14.0

package/dist/models/OptimizationStatus.js

@@ -0,0 +1,64 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptimizationStatusReasonEnum = void 0;
+exports.instanceOfOptimizationStatus = instanceOfOptimizationStatus;
+exports.OptimizationStatusFromJSON = OptimizationStatusFromJSON;
+exports.OptimizationStatusFromJSONTyped = OptimizationStatusFromJSONTyped;
+exports.OptimizationStatusToJSON = OptimizationStatusToJSON;
+exports.OptimizationStatusToJSONTyped = OptimizationStatusToJSONTyped;
+/**
+ * @export
+ */
+exports.OptimizationStatusReasonEnum = {
+    NoUtilizationData: 'no_utilization_data',
+    LowConfidence: 'low_confidence',
+    CalculationError: 'calculation_error',
+    Success: 'success'
+};
+/**
+ * Check if a given object implements the OptimizationStatus interface.
+ */
+function instanceOfOptimizationStatus(value) {
+    if (!('attempted' in value) || value['attempted'] === undefined)
+        return false;
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    return true;
+}
+function OptimizationStatusFromJSON(json) {
+    return OptimizationStatusFromJSONTyped(json, false);
+}
+function OptimizationStatusFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'attempted': json['attempted'],
+        'reason': json['reason'],
+    };
+}
+function OptimizationStatusToJSON(json) {
+    return OptimizationStatusToJSONTyped(json, false);
+}
+function OptimizationStatusToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'attempted': value['attempted'],
+        'reason': value['reason'],
+    };
+}

package/dist/models/Savings.d.ts

@@ -0,0 +1,44 @@
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Infrastructure savings comparison
+ * @export
+ * @interface Savings
+ */
+export interface Savings {
+    /**
+     * Number of nodes saved compared to baseline
+     * @type {number}
+     * @memberof Savings
+     */
+    nodesSaved: number;
+    /**
+     * Percentage reduction in nodes
+     * @type {number}
+     * @memberof Savings
+     */
+    percentageReduction: number;
+    /**
+     * Human-readable description of savings source
+     * @type {string}
+     * @memberof Savings
+     */
+    description: string;
+}
+/**
+ * Check if a given object implements the Savings interface.
+ */
+export declare function instanceOfSavings(value: object): value is Savings;
+export declare function SavingsFromJSON(json: any): Savings;
+export declare function SavingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Savings;
+export declare function SavingsToJSON(json: any): Savings;
+export declare function SavingsToJSONTyped(value?: Savings | null, ignoreDiscriminator?: boolean): any;

package/dist/models/Savings.js

@@ -0,0 +1,58 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSavings = instanceOfSavings;
+exports.SavingsFromJSON = SavingsFromJSON;
+exports.SavingsFromJSONTyped = SavingsFromJSONTyped;
+exports.SavingsToJSON = SavingsToJSON;
+exports.SavingsToJSONTyped = SavingsToJSONTyped;
+/**
+ * Check if a given object implements the Savings interface.
+ */
+function instanceOfSavings(value) {
+    if (!('nodesSaved' in value) || value['nodesSaved'] === undefined)
+        return false;
+    if (!('percentageReduction' in value) || value['percentageReduction'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    return true;
+}
+function SavingsFromJSON(json) {
+    return SavingsFromJSONTyped(json, false);
+}
+function SavingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'nodesSaved': json['nodesSaved'],
+        'percentageReduction': json['percentageReduction'],
+        'description': json['description'],
+    };
+}
+function SavingsToJSON(json) {
+    return SavingsToJSONTyped(json, false);
+}
+function SavingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'nodesSaved': value['nodesSaved'],
+        'percentageReduction': value['percentageReduction'],
+        'description': value['description'],
+    };
+}

package/dist/models/index.d.ts

@@ -47,6 +47,7 @@ export * from './MigrationEstimationResponse.js';
 export * from './MigrationIssue.js';
 export * from './ModelError.js';
 export * from './Network.js';
+export * from './OptimizationStatus.js';
 export * from './OsDiskEstimationEntry.js';
 export * from './OsInfo.js';
 export * from './PartnerRequest.js';
@@ -55,6 +56,7 @@ export * from './PartnerRequestStatus.js';
 export * from './PartnerRequestUpdate.js';
 export * from './PartnerSummary.js';
 export * from './PresignedUrl.js';
+export * from './Savings.js';
 export * from './SchemaEstimationResult.js';
 export * from './SharingSubject.js';
 export * from './SizingOverCommitRatio.js';

package/dist/models/index.js

@@ -65,6 +65,7 @@ __exportStar(require("./MigrationEstimationResponse.js"), exports);
 __exportStar(require("./MigrationIssue.js"), exports);
 __exportStar(require("./ModelError.js"), exports);
 __exportStar(require("./Network.js"), exports);
+__exportStar(require("./OptimizationStatus.js"), exports);
 __exportStar(require("./OsDiskEstimationEntry.js"), exports);
 __exportStar(require("./OsInfo.js"), exports);
 __exportStar(require("./PartnerRequest.js"), exports);
@@ -73,6 +74,7 @@ __exportStar(require("./PartnerRequestStatus.js"), exports);
 __exportStar(require("./PartnerRequestUpdate.js"), exports);
 __exportStar(require("./PartnerSummary.js"), exports);
 __exportStar(require("./PresignedUrl.js"), exports);
+__exportStar(require("./Savings.js"), exports);
 __exportStar(require("./SchemaEstimationResult.js"), exports);
 __exportStar(require("./SharingSubject.js"), exports);
 __exportStar(require("./SizingOverCommitRatio.js"), exports);

package/docs/ClusterRequirementsResponse.md

@@ -8,6 +8,9 @@ Cluster requirements calculation results
 Name | Type
 ------------ | -------------
 `clusterSizing` | [ClusterSizing](ClusterSizing.md)
+`optimizedSizing` | [ClusterSizing](ClusterSizing.md)
+`savings` | [Savings](Savings.md)
+`optimizationStatus` | [OptimizationStatus](OptimizationStatus.md)
 `resourceConsumption` | [SizingResourceConsumption](SizingResourceConsumption.md)
 `inventoryTotals` | [InventoryTotals](InventoryTotals.md)
 
@@ -19,6 +22,9 @@ import type { ClusterRequirementsResponse } from '@openshift-migration-advisor/p
 // TODO: Update the object below with actual values
 const example = {
   "clusterSizing": null,
+  "optimizedSizing": null,
+  "savings": null,
+  "optimizationStatus": null,
   "resourceConsumption": null,
   "inventoryTotals": null,
 } satisfies ClusterRequirementsResponse

package/docs/ClusterSizing.md

@@ -13,6 +13,9 @@ Name | Type
 `failoverNodes` | number
 `totalCPU` | number
 `totalMemory` | number
+`cpuUtilizationMax` | number
+`memoryUtilizationMax` | number
+`confidence` | number
 
 ## Example
 
@@ -27,6 +30,9 @@ const example = {
   "failoverNodes": null,
   "totalCPU": null,
   "totalMemory": null,
+  "cpuUtilizationMax": null,
+  "memoryUtilizationMax": null,
+  "confidence": null,
 } satisfies ClusterSizing
 
 console.log(example)

package/docs/OptimizationStatus.md

@@ -0,0 +1,37 @@
+
+# OptimizationStatus
+
+Status of utilization-based optimization attempt
+
+## Properties
+
+Name | Type
+------------ | -------------
+`attempted` | boolean
+`reason` | string
+
+## Example
+
+```typescript
+import type { OptimizationStatus } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "attempted": null,
+  "reason": null,
+} satisfies OptimizationStatus
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as OptimizationStatus
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Savings.md

@@ -0,0 +1,39 @@
+
+# Savings
+
+Infrastructure savings comparison
+
+## Properties
+
+Name | Type
+------------ | -------------
+`nodesSaved` | number
+`percentageReduction` | number
+`description` | string
+
+## Example
+
+```typescript
+import type { Savings } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "nodesSaved": null,
+  "percentageReduction": null,
+  "description": null,
+} satisfies Savings
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Savings
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openshift-migration-advisor/planner-sdk",
-  "version": "0.13.7",
+  "version": "0.14.0",
   "description": "OpenAPI client for @openshift-migration-advisor/planner-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/models/ClusterRequirementsResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime.js';
+import type { Savings } from './Savings.js';
+import {
+    SavingsFromJSON,
+    SavingsFromJSONTyped,
+    SavingsToJSON,
+    SavingsToJSONTyped,
+} from './Savings.js';
 import type { SizingResourceConsumption } from './SizingResourceConsumption.js';
 import {
     SizingResourceConsumptionFromJSON,
@@ -34,6 +41,13 @@ import {
     ClusterSizingToJSON,
     ClusterSizingToJSONTyped,
 } from './ClusterSizing.js';
+import type { OptimizationStatus } from './OptimizationStatus.js';
+import {
+    OptimizationStatusFromJSON,
+    OptimizationStatusFromJSONTyped,
+    OptimizationStatusToJSON,
+    OptimizationStatusToJSONTyped,
+} from './OptimizationStatus.js';
 
 /**
  * Cluster requirements calculation results
@@ -47,6 +61,24 @@ export interface ClusterRequirementsResponse {
      * @memberof ClusterRequirementsResponse
      */
     clusterSizing: ClusterSizing;
+    /**
+     * 
+     * @type {ClusterSizing}
+     * @memberof ClusterRequirementsResponse
+     */
+    optimizedSizing?: ClusterSizing;
+    /**
+     * 
+     * @type {Savings}
+     * @memberof ClusterRequirementsResponse
+     */
+    savings?: Savings;
+    /**
+     * 
+     * @type {OptimizationStatus}
+     * @memberof ClusterRequirementsResponse
+     */
+    optimizationStatus?: OptimizationStatus;
     /**
      * 
      * @type {SizingResourceConsumption}
@@ -82,6 +114,9 @@ export function ClusterRequirementsResponseFromJSONTyped(json: any, ignoreDiscri
     return {
         
         'clusterSizing': ClusterSizingFromJSON(json['clusterSizing']),
+        'optimizedSizing': json['optimizedSizing'] == null ? undefined : ClusterSizingFromJSON(json['optimizedSizing']),
+        'savings': json['savings'] == null ? undefined : SavingsFromJSON(json['savings']),
+        'optimizationStatus': json['optimizationStatus'] == null ? undefined : OptimizationStatusFromJSON(json['optimizationStatus']),
         'resourceConsumption': SizingResourceConsumptionFromJSON(json['resourceConsumption']),
         'inventoryTotals': InventoryTotalsFromJSON(json['inventoryTotals']),
     };
@@ -99,6 +134,9 @@ export function ClusterRequirementsResponseToJSONTyped(value?: ClusterRequiremen
     return {
         
         'clusterSizing': ClusterSizingToJSON(value['clusterSizing']),
+        'optimizedSizing': ClusterSizingToJSON(value['optimizedSizing']),
+        'savings': SavingsToJSON(value['savings']),
+        'optimizationStatus': OptimizationStatusToJSON(value['optimizationStatus']),
         'resourceConsumption': SizingResourceConsumptionToJSON(value['resourceConsumption']),
         'inventoryTotals': InventoryTotalsToJSON(value['inventoryTotals']),
     };

package/src/models/ClusterRequirementsStoredInput.ts

@@ -95,7 +95,8 @@ export const ClusterRequirementsStoredInputCpuOverCommitRatioEnum = {
     _11: '1:1',
     _12: '1:2',
     _14: '1:4',
-    _16: '1:6'
+    _16: '1:6',
+    _18: '1:8'
 } as const;
 export type ClusterRequirementsStoredInputCpuOverCommitRatioEnum = typeof ClusterRequirementsStoredInputCpuOverCommitRatioEnum[keyof typeof ClusterRequirementsStoredInputCpuOverCommitRatioEnum];
 

package/src/models/ClusterSizing.ts

@@ -55,6 +55,24 @@ export interface ClusterSizing {
      * @memberof ClusterSizing
      */
     totalMemory: number;
+    /**
+     * CPU utilization maximum percentage (only in optimized_sizing)
+     * @type {number}
+     * @memberof ClusterSizing
+     */
+    cpuUtilizationMax?: number;
+    /**
+     * Memory utilization maximum percentage (only in optimized_sizing)
+     * @type {number}
+     * @memberof ClusterSizing
+     */
+    memoryUtilizationMax?: number;
+    /**
+     * Data coverage confidence 0-100 (only in optimized_sizing)
+     * @type {number}
+     * @memberof ClusterSizing
+     */
+    confidence?: number;
 }
 
 /**
@@ -86,6 +104,9 @@ export function ClusterSizingFromJSONTyped(json: any, ignoreDiscriminator: boole
         'failoverNodes': json['failoverNodes'],
         'totalCPU': json['totalCPU'],
         'totalMemory': json['totalMemory'],
+        'cpuUtilizationMax': json['cpuUtilizationMax'] == null ? undefined : json['cpuUtilizationMax'],
+        'memoryUtilizationMax': json['memoryUtilizationMax'] == null ? undefined : json['memoryUtilizationMax'],
+        'confidence': json['confidence'] == null ? undefined : json['confidence'],
     };
 }
 
@@ -106,6 +127,9 @@ export function ClusterSizingToJSONTyped(value?: ClusterSizing | null, ignoreDis
         'failoverNodes': value['failoverNodes'],
         'totalCPU': value['totalCPU'],
         'totalMemory': value['totalMemory'],
+        'cpuUtilizationMax': value['cpuUtilizationMax'],
+        'memoryUtilizationMax': value['memoryUtilizationMax'],
+        'confidence': value['confidence'],
     };
 }
 

package/src/models/CpuOverCommitRatio.ts

@@ -21,7 +21,8 @@ export const CpuOverCommitRatio = {
     CpuOneToOne: '1:1',
     CpuOneToTwo: '1:2',
     CpuOneToFour: '1:4',
-    CpuOneToSix: '1:6'
+    CpuOneToSix: '1:6',
+    CpuOneToEight: '1:8'
 } as const;
 export type CpuOverCommitRatio = typeof CpuOverCommitRatio[keyof typeof CpuOverCommitRatio];
 

package/src/models/OptimizationStatus.ts

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+/**
+ * Status of utilization-based optimization attempt
+ * @export
+ * @interface OptimizationStatus
+ */
+export interface OptimizationStatus {
+    /**
+     * Whether optimization was attempted based on available utilization data
+     * @type {boolean}
+     * @memberof OptimizationStatus
+     */
+    attempted: boolean;
+    /**
+     * Reason for optimization result
+     * @type {OptimizationStatusReasonEnum}
+     * @memberof OptimizationStatus
+     */
+    reason: OptimizationStatusReasonEnum;
+}
+
+
+/**
+ * @export
+ */
+export const OptimizationStatusReasonEnum = {
+    NoUtilizationData: 'no_utilization_data',
+    LowConfidence: 'low_confidence',
+    CalculationError: 'calculation_error',
+    Success: 'success'
+} as const;
+export type OptimizationStatusReasonEnum = typeof OptimizationStatusReasonEnum[keyof typeof OptimizationStatusReasonEnum];
+
+
+/**
+ * Check if a given object implements the OptimizationStatus interface.
+ */
+export function instanceOfOptimizationStatus(value: object): value is OptimizationStatus {
+    if (!('attempted' in value) || value['attempted'] === undefined) return false;
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    return true;
+}
+
+export function OptimizationStatusFromJSON(json: any): OptimizationStatus {
+    return OptimizationStatusFromJSONTyped(json, false);
+}
+
+export function OptimizationStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): OptimizationStatus {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'attempted': json['attempted'],
+        'reason': json['reason'],
+    };
+}
+
+export function OptimizationStatusToJSON(json: any): OptimizationStatus {
+    return OptimizationStatusToJSONTyped(json, false);
+}
+
+export function OptimizationStatusToJSONTyped(value?: OptimizationStatus | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'attempted': value['attempted'],
+        'reason': value['reason'],
+    };
+}
+

package/src/models/Savings.ts

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+/**
+ * Infrastructure savings comparison
+ * @export
+ * @interface Savings
+ */
+export interface Savings {
+    /**
+     * Number of nodes saved compared to baseline
+     * @type {number}
+     * @memberof Savings
+     */
+    nodesSaved: number;
+    /**
+     * Percentage reduction in nodes
+     * @type {number}
+     * @memberof Savings
+     */
+    percentageReduction: number;
+    /**
+     * Human-readable description of savings source
+     * @type {string}
+     * @memberof Savings
+     */
+    description: string;
+}
+
+/**
+ * Check if a given object implements the Savings interface.
+ */
+export function instanceOfSavings(value: object): value is Savings {
+    if (!('nodesSaved' in value) || value['nodesSaved'] === undefined) return false;
+    if (!('percentageReduction' in value) || value['percentageReduction'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    return true;
+}
+
+export function SavingsFromJSON(json: any): Savings {
+    return SavingsFromJSONTyped(json, false);
+}
+
+export function SavingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Savings {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'nodesSaved': json['nodesSaved'],
+        'percentageReduction': json['percentageReduction'],
+        'description': json['description'],
+    };
+}
+
+export function SavingsToJSON(json: any): Savings {
+    return SavingsToJSONTyped(json, false);
+}
+
+export function SavingsToJSONTyped(value?: Savings | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'nodesSaved': value['nodesSaved'],
+        'percentageReduction': value['percentageReduction'],
+        'description': value['description'],
+    };
+}
+

package/src/models/index.ts

@@ -49,6 +49,7 @@ export * from './MigrationEstimationResponse.js';
 export * from './MigrationIssue.js';
 export * from './ModelError.js';
 export * from './Network.js';
+export * from './OptimizationStatus.js';
 export * from './OsDiskEstimationEntry.js';
 export * from './OsInfo.js';
 export * from './PartnerRequest.js';
@@ -57,6 +58,7 @@ export * from './PartnerRequestStatus.js';
 export * from './PartnerRequestUpdate.js';
 export * from './PartnerSummary.js';
 export * from './PresignedUrl.js';
+export * from './Savings.js';
 export * from './SchemaEstimationResult.js';
 export * from './SharingSubject.js';
 export * from './SizingOverCommitRatio.js';