@openshift-migration-advisor/agent-sdk 0.8.0 → 0.12.0-1f1dc16fb9e5

package/docs/EstimateRange.md

@@ -0,0 +1,39 @@
+
+# EstimateRange
+
+Time estimates for migrating 1TB of data
+
+## Properties
+
+Name | Type
+------------ | -------------
+`bestCase` | string
+`expected` | string
+`worstCase` | string
+
+## Example
+
+```typescript
+import type { EstimateRange } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "bestCase": null,
+  "expected": null,
+  "worstCase": null,
+} satisfies EstimateRange
+
+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 EstimateRange
+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/ForecastStats.md

@@ -0,0 +1,52 @@
+
+# ForecastStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pairName` | string
+`sampleCount` | number
+`meanMbps` | number
+`medianMbps` | number
+`minMbps` | number
+`maxMbps` | number
+`stddevMbps` | number
+`ci95LowerMbps` | number
+`ci95UpperMbps` | number
+`estimatePer1TB` | [EstimateRange](EstimateRange.md)
+
+## Example
+
+```typescript
+import type { ForecastStats } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pairName": null,
+  "sampleCount": null,
+  "meanMbps": null,
+  "medianMbps": null,
+  "minMbps": null,
+  "maxMbps": null,
+  "stddevMbps": null,
+  "ci95LowerMbps": null,
+  "ci95UpperMbps": null,
+  "estimatePer1TB": null,
+} satisfies ForecastStats
+
+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 ForecastStats
+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/ForecasterDatastoresRequest.md

@@ -0,0 +1,34 @@
+
+# ForecasterDatastoresRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`credentials` | [VcenterCredentials](VcenterCredentials.md)
+
+## Example
+
+```typescript
+import type { ForecasterDatastoresRequest } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "credentials": null,
+} satisfies ForecasterDatastoresRequest
+
+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 ForecasterDatastoresRequest
+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/ForecasterPairStatus.md

@@ -0,0 +1,52 @@
+
+# ForecasterPairStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pairName` | string
+`sourceDatastore` | string
+`targetDatastore` | string
+`host` | string
+`state` | string
+`error` | string
+`completedRuns` | number
+`totalRuns` | number
+`prepBytesTotal` | number
+`prepBytesUploaded` | number
+
+## Example
+
+```typescript
+import type { ForecasterPairStatus } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pairName": null,
+  "sourceDatastore": null,
+  "targetDatastore": null,
+  "host": null,
+  "state": null,
+  "error": null,
+  "completedRuns": null,
+  "totalRuns": null,
+  "prepBytesTotal": null,
+  "prepBytesUploaded": null,
+} satisfies ForecasterPairStatus
+
+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 ForecasterPairStatus
+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/ForecasterStartRequest.md

@@ -0,0 +1,42 @@
+
+# ForecasterStartRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`credentials` | [VcenterCredentials](VcenterCredentials.md)
+`pairs` | [Array<DatastorePair>](DatastorePair.md)
+`diskSizeGb` | number
+`iterations` | number
+`concurrency` | number
+
+## Example
+
+```typescript
+import type { ForecasterStartRequest } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "credentials": null,
+  "pairs": null,
+  "diskSizeGb": null,
+  "iterations": null,
+  "concurrency": null,
+} satisfies ForecasterStartRequest
+
+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 ForecasterStartRequest
+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/ForecasterStatus.md

@@ -0,0 +1,36 @@
+
+# ForecasterStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`state` | string
+`pairs` | [Array<ForecasterPairStatus>](ForecasterPairStatus.md)
+
+## Example
+
+```typescript
+import type { ForecasterStatus } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "state": null,
+  "pairs": null,
+} satisfies ForecasterStatus
+
+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 ForecasterStatus
+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/InspectorStatus.md

@@ -7,6 +7,8 @@
 Name | Type
 ------------ | -------------
 `state` | string
+`credentials` | [VcenterCredentials](VcenterCredentials.md)
+`vddk` | [VddkProperties](VddkProperties.md)
 `error` | string
 
 ## Example
@@ -17,6 +19,8 @@ import type { InspectorStatus } from '@openshift-migration-advisor/agent-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "state": null,
+  "credentials": null,
+  "vddk": null,
   "error": null,
 } satisfies InspectorStatus
 

package/docs/PairCapability.md

@@ -0,0 +1,40 @@
+
+# PairCapability
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pairName` | string
+`sourceDatastore` | string
+`targetDatastore` | string
+`capabilities` | Array<string>
+
+## Example
+
+```typescript
+import type { PairCapability } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pairName": null,
+  "sourceDatastore": null,
+  "targetDatastore": null,
+  "capabilities": null,
+} satisfies PairCapability
+
+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 PairCapability
+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/PairCapabilityRequest.md

@@ -0,0 +1,36 @@
+
+# PairCapabilityRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`credentials` | [VcenterCredentials](VcenterCredentials.md)
+`pairs` | [Array<DatastorePair>](DatastorePair.md)
+
+## Example
+
+```typescript
+import type { PairCapabilityRequest } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "credentials": null,
+  "pairs": null,
+} satisfies PairCapabilityRequest
+
+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 PairCapabilityRequest
+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/PutForecasterCredentials403Response.md

@@ -0,0 +1,36 @@
+
+# PutForecasterCredentials403Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`missingPrivileges` | Array<string>
+
+## Example
+
+```typescript
+import type { PutForecasterCredentials403Response } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": insufficient vSphere privileges, missing: [Datastore.AllocateSpace VirtualMachine.Inventory.Create],
+  "missingPrivileges": ["Datastore.AllocateSpace","VirtualMachine.Inventory.Create"],
+} satisfies PutForecasterCredentials403Response
+
+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 PutForecasterCredentials403Response
+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/RightsizingCollectRequest.md

@@ -0,0 +1,46 @@
+
+# RightsizingCollectRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`credentials` | [VcenterCredentials](VcenterCredentials.md)
+`lookbackHours` | number
+`intervalId` | number
+`nameFilter` | string
+`clusterId` | string
+`batchSize` | number
+`discoverVms` | boolean
+
+## Example
+
+```typescript
+import type { RightsizingCollectRequest } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "credentials": null,
+  "lookbackHours": null,
+  "intervalId": null,
+  "nameFilter": null,
+  "clusterId": null,
+  "batchSize": null,
+  "discoverVms": null,
+} satisfies RightsizingCollectRequest
+
+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 RightsizingCollectRequest
+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/RightsizingMetricStats.md

@@ -0,0 +1,44 @@
+
+# RightsizingMetricStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sampleCount` | number
+`average` | number
+`p95` | number
+`p99` | number
+`max` | number
+`latest` | number
+
+## Example
+
+```typescript
+import type { RightsizingMetricStats } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sampleCount": null,
+  "average": null,
+  "p95": null,
+  "p99": null,
+  "max": null,
+  "latest": null,
+} satisfies RightsizingMetricStats
+
+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 RightsizingMetricStats
+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/RightsizingReport.md

@@ -0,0 +1,50 @@
+
+# RightsizingReport
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`vcenter` | string
+`clusterId` | string
+`windowStart` | Date
+`windowEnd` | Date
+`intervalId` | number
+`expectedSampleCount` | number
+`vms` | [Array<RightsizingVMReport>](RightsizingVMReport.md)
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { RightsizingReport } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "vcenter": null,
+  "clusterId": null,
+  "windowStart": null,
+  "windowEnd": null,
+  "intervalId": null,
+  "expectedSampleCount": null,
+  "vms": null,
+  "createdAt": null,
+} satisfies RightsizingReport
+
+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 RightsizingReport
+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/RightsizingReportListResponse.md

@@ -0,0 +1,36 @@
+
+# RightsizingReportListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reports` | [Array<RightsizingReportSummary>](RightsizingReportSummary.md)
+`total` | number
+
+## Example
+
+```typescript
+import type { RightsizingReportListResponse } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reports": null,
+  "total": null,
+} satisfies RightsizingReportListResponse
+
+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 RightsizingReportListResponse
+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/RightsizingReportSummary.md

@@ -0,0 +1,49 @@
+
+# RightsizingReportSummary
+
+Rightsizing report metadata without VM metrics. Use GET /rightsizing/{id} to retrieve the full report including metrics.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`vcenter` | string
+`clusterId` | string
+`windowStart` | Date
+`windowEnd` | Date
+`intervalId` | number
+`expectedSampleCount` | number
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { RightsizingReportSummary } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "vcenter": null,
+  "clusterId": null,
+  "windowStart": null,
+  "windowEnd": null,
+  "intervalId": null,
+  "expectedSampleCount": null,
+  "createdAt": null,
+} satisfies RightsizingReportSummary
+
+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 RightsizingReportSummary
+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/RightsizingVMReport.md

@@ -0,0 +1,40 @@
+
+# RightsizingVMReport
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`moid` | string
+`metrics` | [{ [key: string]: RightsizingMetricStats; }](RightsizingMetricStats.md)
+`warnings` | Array<string>
+
+## Example
+
+```typescript
+import type { RightsizingVMReport } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "moid": null,
+  "metrics": null,
+  "warnings": null,
+} satisfies RightsizingVMReport
+
+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 RightsizingVMReport
+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)
+
+