Class LiveRemoteKernelConnectionMetadata

src/kernels/types.ts:95–154

 * With this we are able connect to an existing kernel (instead of starting a new session).
 */
export class LiveRemoteKernelConnectionMetadata {
    public readonly kind = 'connectToLiveRemoteKernel';
    public readonly kernelModel: LiveKernelModel;
    public readonly baseUrl: string;
    public readonly serverProviderHandle: JupyterServerProviderHandle;
    public readonly id: string;
    /**
     * Python interpreter will be used for intellisense & the like.
     */
    public readonly interpreter?: PythonEnvironment;

    private constructor(options: {
        kernelModel: LiveKernelModel;
        /**
         * Python interpreter will be used for intellisense & the like.
         */
        interpreter?: PythonEnvironment;
        baseUrl: string;
        id: string;
        serverProviderHandle: JupyterServerProviderHandle;
    }) {
        this.kernelModel = options.kernelModel;
        this.interpreter = options.interpreter;
        this.baseUrl = options.baseUrl;
        this.id = options.id;
        this.serverProviderHandle = options.serverProviderHandle;
        sendKernelTelemetry(this);
    }
    public static create(options: {
        kernelModel: LiveKernelModel;
        /**
         * Python interpreter will be used for intellisense & the like.
         */
        interpreter?: PythonEnvironment;
        baseUrl: string;
        id: string;
        serverProviderHandle: JupyterServerProviderHandle;
    }) {
        return new LiveRemoteKernelConnectionMetadata(options);
    }
    public updateModel(model: LiveKernelModel) {
        Object.assign(this.kernelModel, model);
    }
    public getHashId() {
        return getConnectionIdHash(this);
    }
    public toJSON() {
        return {
            id: this.id,
            kind: this.kind,
            baseUrl: this.baseUrl,
            interpreter: serializePythonEnvironment(this.interpreter),
            kernelModel: this.kernelModel,
            serverProviderHandle: this.serverProviderHandle
        };
    }
    public static fromJSON(json: Record<string, unknown> | LiveRemoteKernelConnectionMetadata) {
        return BaseKernelConnectionMetadata.fromJSON(json) as LiveRemoteKernelConnectionMetadata;