@openshift-migration-advisor/planner-sdk 0.18.0 → 0.20.0

package/dist/models/SourceUpdate.d.ts

@@ -20,56 +20,38 @@ import type { Label } from './Label.js';
 export interface SourceUpdate {
     /**
      *
-     * @type {string}
-     * @memberof SourceUpdate
      */
     name?: string;
     /**
      *
-     * @type {Array<Label>}
-     * @memberof SourceUpdate
      */
     labels?: Array<Label>;
     /**
      *
-     * @type {string}
-     * @memberof SourceUpdate
      */
     sshPublicKey?: string | null;
     /**
      *
-     * @type {string}
-     * @memberof SourceUpdate
      */
     certificateChain?: string | null;
     /**
      *
-     * @type {AgentProxy}
-     * @memberof SourceUpdate
      */
     proxy?: AgentProxy;
     /**
      *
-     * @type {VmNetwork}
-     * @memberof SourceUpdate
      */
     network?: VmNetwork;
     /**
      *
-     * @type {VmNetwork}
-     * @memberof SourceUpdate
      */
     vmNetwork?: VmNetwork;
     /**
      * Set to false to clear all proxy fields. When true or omitted, proxy fields are preserved or updated normally.
-     * @type {boolean}
-     * @memberof SourceUpdate
      */
     enableProxy?: boolean;
     /**
      * Set to dhcp to clear all network fields. Set to static when providing vmNetwork/network data. When omitted, network fields are preserved or updated normally.
-     * @type {SourceUpdateNetworkConfigTypeEnum}
-     * @memberof SourceUpdate
      */
     networkConfigType?: SourceUpdateNetworkConfigTypeEnum;
 }

package/dist/models/StandaloneClusterRequirementsRequest.d.ts

@@ -19,86 +19,58 @@ import type { MemoryOverCommitRatio } from './MemoryOverCommitRatio.js';
 export interface StandaloneClusterRequirementsRequest {
     /**
      * Total number of VMs to size for
-     * @type {number}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     totalVMs: number;
     /**
      * Total CPU cores across all VMs
-     * @type {number}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     totalCPU: number;
     /**
      * Total memory (GB) across all VMs
-     * @type {number}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     totalMemory: number;
     /**
      * CPU over-commit ratio (e.g., "1:4")
-     * @type {CpuOverCommitRatio}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     cpuOverCommitRatio: CpuOverCommitRatio;
     /**
      * Memory over-commit ratio (e.g., "1:2")
-     * @type {MemoryOverCommitRatio}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     memoryOverCommitRatio: MemoryOverCommitRatio;
     /**
      * CPU cores per worker node
-     * @type {number}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     workerNodeCPU: number;
     /**
      * Memory (GB) per worker node
-     * @type {number}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     workerNodeMemory: number;
     /**
      * Number of CPU threads per worker node (for SMT calculation). If not provided, assumes no SMT (threads = cores). Must be >= workerNodeCPU
-     * @type {number}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     workerNodeThreads?: number;
     /**
      * Allow workload scheduling on control plane nodes (default: false)
-     * @type {boolean}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     controlPlaneSchedulable?: boolean;
     /**
      * CPU cores per control plane node (default: 6)
-     * @type {number}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     controlPlaneCPU?: number;
     /**
      * Memory in GB per control plane node (default: 16)
-     * @type {number}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     controlPlaneMemory?: number;
     /**
      * Number of control plane nodes: 1 or 3 (default: 3)
-     * @type {StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     controlPlaneNodeCount?: StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum;
     /**
      * If true, control plane is hosted externally. Incompatible with control plane fields (default: false)
-     * @type {boolean}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     hostedControlPlane?: boolean;
     /**
      * If true, creates a 3-node compact cluster with no dedicated workers. Requires controlPlaneNodeCount=3 and controlPlaneSchedulable=true. Incompatible with hostedControlPlane=true
-     * @type {boolean}
-     * @memberof StandaloneClusterRequirementsRequest
      */
     compactMode?: boolean;
 }

package/dist/models/StandaloneClusterRequirementsResponse.d.ts

@@ -19,14 +19,10 @@ import type { ClusterSizing } from './ClusterSizing.js';
 export interface StandaloneClusterRequirementsResponse {
     /**
      *
-     * @type {ClusterSizing}
-     * @memberof StandaloneClusterRequirementsResponse
      */
     clusterSizing: ClusterSizing;
     /**
      *
-     * @type {SizingResourceConsumption}
-     * @memberof StandaloneClusterRequirementsResponse
      */
     resourceConsumption: SizingResourceConsumption;
 }

package/dist/models/Status.d.ts

@@ -17,20 +17,14 @@
 export interface Status {
     /**
      * A human-readable description of the status of this operation.
-     * @type {string}
-     * @memberof Status
      */
     message?: string;
     /**
      * A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
-     * @type {string}
-     * @memberof Status
      */
     reason?: string;
     /**
      * Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
-     * @type {string}
-     * @memberof Status
      */
     status?: string;
 }

package/dist/models/StorageIoConfiguration.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface StorageIoConfiguration
+ */
+export interface StorageIoConfiguration {
+    /**
+     * Whether Storage I/O Control is enabled for this datastore
+     */
+    enabled?: boolean;
+    /**
+     * Latency threshold in milliseconds beyond which the storage array is considered congested
+     */
+    congestionThreshold?: number;
+    /**
+     * Mode for congestion threshold calculation
+     */
+    congestionThresholdMode?: StorageIoConfigurationCongestionThresholdModeEnum;
+    /**
+     * Percent of peak throughput
+     */
+    percentOfPeakThroughput?: number;
+}
+/**
+ * @export
+ */
+export declare const StorageIoConfigurationCongestionThresholdModeEnum: {
+    readonly Automatic: "automatic";
+    readonly Manual: "manual";
+};
+export type StorageIoConfigurationCongestionThresholdModeEnum = typeof StorageIoConfigurationCongestionThresholdModeEnum[keyof typeof StorageIoConfigurationCongestionThresholdModeEnum];
+/**
+ * Check if a given object implements the StorageIoConfiguration interface.
+ */
+export declare function instanceOfStorageIoConfiguration(value: object): value is StorageIoConfiguration;
+export declare function StorageIoConfigurationFromJSON(json: any): StorageIoConfiguration;
+export declare function StorageIoConfigurationFromJSONTyped(json: any, ignoreDiscriminator: boolean): StorageIoConfiguration;
+export declare function StorageIoConfigurationToJSON(json: any): StorageIoConfiguration;
+export declare function StorageIoConfigurationToJSONTyped(value?: StorageIoConfiguration | null, ignoreDiscriminator?: boolean): any;

package/dist/models/StorageIoConfiguration.js

@@ -0,0 +1,62 @@
+"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.StorageIoConfigurationCongestionThresholdModeEnum = void 0;
+exports.instanceOfStorageIoConfiguration = instanceOfStorageIoConfiguration;
+exports.StorageIoConfigurationFromJSON = StorageIoConfigurationFromJSON;
+exports.StorageIoConfigurationFromJSONTyped = StorageIoConfigurationFromJSONTyped;
+exports.StorageIoConfigurationToJSON = StorageIoConfigurationToJSON;
+exports.StorageIoConfigurationToJSONTyped = StorageIoConfigurationToJSONTyped;
+/**
+ * @export
+ */
+exports.StorageIoConfigurationCongestionThresholdModeEnum = {
+    Automatic: 'automatic',
+    Manual: 'manual'
+};
+/**
+ * Check if a given object implements the StorageIoConfiguration interface.
+ */
+function instanceOfStorageIoConfiguration(value) {
+    return true;
+}
+function StorageIoConfigurationFromJSON(json) {
+    return StorageIoConfigurationFromJSONTyped(json, false);
+}
+function StorageIoConfigurationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+        'congestionThreshold': json['congestionThreshold'] == null ? undefined : json['congestionThreshold'],
+        'congestionThresholdMode': json['congestionThresholdMode'] == null ? undefined : json['congestionThresholdMode'],
+        'percentOfPeakThroughput': json['percentOfPeakThroughput'] == null ? undefined : json['percentOfPeakThroughput'],
+    };
+}
+function StorageIoConfigurationToJSON(json) {
+    return StorageIoConfigurationToJSONTyped(json, false);
+}
+function StorageIoConfigurationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'enabled': value['enabled'],
+        'congestionThreshold': value['congestionThreshold'],
+        'congestionThresholdMode': value['congestionThresholdMode'],
+        'percentOfPeakThroughput': value['percentOfPeakThroughput'],
+    };
+}

package/dist/models/UpdateInventory.d.ts

@@ -18,14 +18,10 @@ import type { Inventory } from './Inventory.js';
 export interface UpdateInventory {
     /**
      *
-     * @type {string}
-     * @memberof UpdateInventory
      */
     agentId: string;
     /**
      *
-     * @type {Inventory}
-     * @memberof UpdateInventory
      */
     inventory: Inventory;
 }

package/dist/models/VCenter.d.ts

@@ -17,8 +17,6 @@
 export interface VCenter {
     /**
      *
-     * @type {string}
-     * @memberof VCenter
      */
     id: string;
 }

package/dist/models/VMResourceBreakdown.d.ts

@@ -18,32 +18,22 @@ import type { Histogram } from './Histogram.js';
 export interface VMResourceBreakdown {
     /**
      *
-     * @type {number}
-     * @memberof VMResourceBreakdown
      */
     total: number;
     /**
      *
-     * @type {number}
-     * @memberof VMResourceBreakdown
      */
     totalForMigratable: number;
     /**
      *
-     * @type {number}
-     * @memberof VMResourceBreakdown
      */
     totalForMigratableWithWarnings: number;
     /**
      *
-     * @type {number}
-     * @memberof VMResourceBreakdown
      */
     totalForNotMigratable: number;
     /**
      *
-     * @type {Histogram}
-     * @memberof VMResourceBreakdown
      * @deprecated
      */
     histogram?: Histogram;

package/dist/models/VMs.d.ts

@@ -23,38 +23,26 @@ import type { VMResourceBreakdown } from './VMResourceBreakdown.js';
 export interface VMs {
     /**
      *
-     * @type {number}
-     * @memberof VMs
      */
     total: number;
     /**
      *
-     * @type {number}
-     * @memberof VMs
      */
     totalMigratable: number;
     /**
      *
-     * @type {number}
-     * @memberof VMs
      */
     totalMigratableWithWarnings?: number;
     /**
      * Number of VMs that have at least one shared disk
-     * @type {number}
-     * @memberof VMs
      */
     totalWithSharedDisks?: number;
     /**
      *
-     * @type {VMResourceBreakdown}
-     * @memberof VMs
      */
     cpuCores: VMResourceBreakdown;
     /**
      *
-     * @type {{ [key: string]: DiskSizeTierSummary; }}
-     * @memberof VMs
      */
     diskSizeTier?: {
         [key: string]: DiskSizeTierSummary;
@@ -62,48 +50,36 @@ export interface VMs {
     /**
      * Distribution of VMs across disk-complexity tiers used by the estimation engine (0-10TiB, 10-20TiB, 20-50TiB, 50+TiB).
      *
-     * @type {{ [key: string]: DiskSizeTierSummary; }}
-     * @memberof VMs
      */
     diskComplexityTier?: {
         [key: string]: DiskSizeTierSummary;
     };
     /**
      *
-     * @type {{ [key: string]: DiskTypeSummary; }}
-     * @memberof VMs
      */
     diskTypes?: {
         [key: string]: DiskTypeSummary;
     };
     /**
      * Distribution of VMs across CPU tier buckets (e.g., "0-4", "5-8", "9-16", "17-32", "32+")
-     * @type {{ [key: string]: number; }}
-     * @memberof VMs
      */
     distributionByCpuTier?: {
         [key: string]: number;
     };
     /**
      * Distribution of VMs across Memory tier buckets (e.g., "0-4", "5-16", "17-32", "33-64", "65-128", "129-256", "256+")
-     * @type {{ [key: string]: number; }}
-     * @memberof VMs
      */
     distributionByMemoryTier?: {
         [key: string]: number;
     };
     /**
      * Distribution of VMs by NIC count (e.g., "0", "1", "2", "3", "4+")
-     * @type {{ [key: string]: number; }}
-     * @memberof VMs
      */
     distributionByNicCount?: {
         [key: string]: number;
     };
     /**
      * Distribution of VMs by migration complexity level (0=Unsupported, 1=Easy, 2=Medium, 3=Hard, 4=WhiteGlove)
-     * @type {{ [key: string]: number; }}
-     * @memberof VMs
      * @deprecated
      */
     distributionByComplexity?: {
@@ -111,48 +87,34 @@ export interface VMs {
     };
     /**
      * Distribution of VMs by migration complexity level, enriched with total disk size per level. Supersedes distributionByComplexity.
-     * @type {{ [key: string]: DiskSizeTierSummary; }}
-     * @memberof VMs
      */
     complexityDistribution?: {
         [key: string]: DiskSizeTierSummary;
     };
     /**
      *
-     * @type {VMResourceBreakdown}
-     * @memberof VMs
      */
     ramGB: VMResourceBreakdown;
     /**
      *
-     * @type {VMResourceBreakdown}
-     * @memberof VMs
      */
     diskGB: VMResourceBreakdown;
     /**
      *
-     * @type {VMResourceBreakdown}
-     * @memberof VMs
      */
     diskCount: VMResourceBreakdown;
     /**
      *
-     * @type {VMResourceBreakdown}
-     * @memberof VMs
      */
     nicCount?: VMResourceBreakdown;
     /**
      *
-     * @type {{ [key: string]: number; }}
-     * @memberof VMs
      */
     powerStates: {
         [key: string]: number;
     };
     /**
      *
-     * @type {{ [key: string]: number; }}
-     * @memberof VMs
      * @deprecated
      */
     os?: {
@@ -160,28 +122,20 @@ export interface VMs {
     };
     /**
      *
-     * @type {{ [key: string]: OsInfo; }}
-     * @memberof VMs
      */
     osInfo?: {
         [key: string]: OsInfo;
     };
     /**
      *
-     * @type {Array<MigrationIssue>}
-     * @memberof VMs
      */
     notMigratableReasons: Array<MigrationIssue>;
     /**
      *
-     * @type {Array<MigrationIssue>}
-     * @memberof VMs
      */
     migrationWarnings: Array<MigrationIssue>;
     /**
      *
-     * @type {IssuesBreakdown}
-     * @memberof VMs
      */
     issuesBreakdown?: IssuesBreakdown;
 }

package/dist/models/VmNetwork.d.ts

@@ -18,8 +18,6 @@ import type { Ipv4Config } from './Ipv4Config.js';
 export interface VmNetwork {
     /**
      *
-     * @type {Ipv4Config}
-     * @memberof VmNetwork
      */
     ipv4?: Ipv4Config;
 }

package/dist/models/index.d.ts

@@ -72,6 +72,7 @@ export * from './SourceUpdate.js';
 export * from './StandaloneClusterRequirementsRequest.js';
 export * from './StandaloneClusterRequirementsResponse.js';
 export * from './Status.js';
+export * from './StorageIoConfiguration.js';
 export * from './UpdateInventory.js';
 export * from './VCenter.js';
 export * from './VMResourceBreakdown.js';

package/dist/models/index.js

@@ -90,6 +90,7 @@ __exportStar(require("./SourceUpdate.js"), exports);
 __exportStar(require("./StandaloneClusterRequirementsRequest.js"), exports);
 __exportStar(require("./StandaloneClusterRequirementsResponse.js"), exports);
 __exportStar(require("./Status.js"), exports);
+__exportStar(require("./StorageIoConfiguration.js"), exports);
 __exportStar(require("./UpdateInventory.js"), exports);
 __exportStar(require("./VCenter.js"), exports);
 __exportStar(require("./VMResourceBreakdown.js"), exports);

package/docs/Datastore.md

@@ -15,6 +15,7 @@ Name | Type
 `protocolType` | string
 `model` | string
 `hostId` | string
+`storageIoConfiguration` | [StorageIoConfiguration](StorageIoConfiguration.md)
 
 ## Example
 
@@ -32,6 +33,7 @@ const example = {
   "protocolType": null,
   "model": null,
   "hostId": null,
+  "storageIoConfiguration": null,
 } satisfies Datastore
 
 console.log(example)

package/docs/StorageIoConfiguration.md

@@ -0,0 +1,40 @@
+
+# StorageIoConfiguration
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`congestionThreshold` | number
+`congestionThresholdMode` | string
+`percentOfPeakThroughput` | number
+
+## Example
+
+```typescript
+import type { StorageIoConfiguration } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "congestionThreshold": null,
+  "congestionThresholdMode": null,
+  "percentOfPeakThroughput": null,
+} satisfies StorageIoConfiguration
+
+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 StorageIoConfiguration
+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.18.0",
+  "version": "0.20.0",
   "description": "OpenAPI client for @openshift-migration-advisor/planner-sdk",
   "author": "OpenAPI-Generator",
   "repository": {