@openshift-migration-advisor/agent-sdk 0.12.0 → 0.16.0-f224c4e8e35b

package/docs/CapabilityStatus.md

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

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

@@ -0,0 +1,38 @@
+
+# ClusterFeatures
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`drsEnabled` | boolean
+`drsMode` | string
+`storageDrsEnabled` | boolean
+
+## Example
+
+```typescript
+import type { ClusterFeatures } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "drsEnabled": null,
+  "drsMode": null,
+  "storageDrsEnabled": null,
+} satisfies ClusterFeatures
+
+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 ClusterFeatures
+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/ClusterUtilization.md

@@ -0,0 +1,46 @@
+
+# ClusterUtilization
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cpu_avg` | number
+`cpu_p95` | number
+`cpu_max` | number
+`mem_avg` | number
+`mem_p95` | number
+`mem_max` | number
+`confidence` | number
+
+## Example
+
+```typescript
+import type { ClusterUtilization } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cpu_avg": null,
+  "cpu_p95": null,
+  "cpu_max": null,
+  "mem_avg": null,
+  "mem_p95": null,
+  "mem_max": null,
+  "confidence": null,
+} satisfies ClusterUtilization
+
+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 ClusterUtilization
+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/CollectorStartRequest.md

@@ -1,6 +1,7 @@
 
 # CollectorStartRequest
 
+Start collection. Credentials are optional if previously stored via PUT /credentials.
 
 ## Properties
 
@@ -9,6 +10,8 @@ Name | Type
 `url` | string
 `username` | string
 `password` | string
+`skipTls` | boolean
+`cacert` | string
 
 ## Example
 
@@ -20,6 +23,8 @@ const example = {
   "url": null,
   "username": null,
   "password": null,
+  "skipTls": null,
+  "cacert": null,
 } satisfies CollectorStartRequest
 
 console.log(example)

package/docs/CreateGroupRequest.md

@@ -9,7 +9,6 @@ Name | Type
 `name` | string
 `description` | string
 `filter` | string
-`tags` | Array<string>
 
 ## Example
 
@@ -21,7 +20,6 @@ const example = {
   "name": null,
   "description": null,
   "filter": null,
-  "tags": null,
 } satisfies CreateGroupRequest
 
 console.log(example)

package/docs/CredentialStatus.md

@@ -0,0 +1,38 @@
+
+# CredentialStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+`username` | string
+`valid` | boolean
+
+## Example
+
+```typescript
+import type { CredentialStatus } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": null,
+  "username": null,
+  "valid": null,
+} satisfies CredentialStatus
+
+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 CredentialStatus
+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/DatastoreDetail.md

@@ -0,0 +1,50 @@
+
+# DatastoreDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`type` | string
+`capacityGb` | number
+`freeGb` | number
+`storageVendor` | string
+`storageModel` | string
+`storageArrayId` | string
+`naaDevices` | Array<string>
+`capabilities` | Array<string>
+
+## Example
+
+```typescript
+import type { DatastoreDetail } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "type": null,
+  "capacityGb": null,
+  "freeGb": null,
+  "storageVendor": null,
+  "storageModel": null,
+  "storageArrayId": null,
+  "naaDevices": null,
+  "capabilities": null,
+} satisfies DatastoreDetail
+
+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 DatastoreDetail
+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/DatastorePair.md

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