Skip to main content

Interface: ContainerProviderConnection

Defined in: packages/extension-api/src/extension-api.d.ts:395

Properties​

displayName?​

optional displayName?: string

Defined in: packages/extension-api/src/extension-api.d.ts:397

endpoint​

endpoint: ContainerProviderConnectionEndpoint

Defined in: packages/extension-api/src/extension-api.d.ts:399

error?​

optional error?: string

Defined in: packages/extension-api/src/extension-api.d.ts:409

Optional error message describing why this connection is in a failed state. The connection retains its lifecycle status (e.g. 'starting', 'stopped') while this field provides the error details. Cleared automatically on successful lifecycle transitions.

lifecycle?​

optional lifecycle?: ProviderConnectionLifecycle

Defined in: packages/extension-api/src/extension-api.d.ts:401

name​

name: string

Defined in: packages/extension-api/src/extension-api.d.ts:396

shellAccess?​

optional shellAccess?: ProviderConnectionShellAccess

Defined in: packages/extension-api/src/extension-api.d.ts:400

type​

type: "docker" | "podman"

Defined in: packages/extension-api/src/extension-api.d.ts:398

vmType?​

optional vmType?: string

Defined in: packages/extension-api/src/extension-api.d.ts:410

vmTypeDisplayName?​

optional vmTypeDisplayName?: string

Defined in: packages/extension-api/src/extension-api.d.ts:414

the vmTypeDisplayName property cannot be set if vmType is undefined

Methods​

status()​

status(): ProviderConnectionStatus

Defined in: packages/extension-api/src/extension-api.d.ts:402

Returns​

ProviderConnectionStatus