@openkaiden/opnshll-sdk 0.1.5 → 0.1.7

package/dist/gen/openshell_pb.d.ts

@@ -1147,6 +1147,107 @@ export type CreateSandboxRequest = Message<"openshell.v1.CreateSandboxRequest">
  * Use `create(CreateSandboxRequestSchema)` to create a new message.
  */
 export declare const CreateSandboxRequestSchema: GenMessage<CreateSandboxRequest>;
+/**
+ * Update selected configuration of a stopped sandbox. Omitted fields are unchanged.
+ * Start explicitly after a successful update. With no fields selected, resume
+ * the pending operation stored by the gateway using the current resource version.
+ *
+ * @generated from message openshell.v1.UpdateSandboxRequest
+ */
+export type UpdateSandboxRequest = Message<"openshell.v1.UpdateSandboxRequest"> & {
+    /**
+     * Workspace scope. Only a named workspace selection is accepted.
+     *
+     * @generated from field: openshell.datamodel.v1.WorkspaceSelector workspace_scope = 1;
+     */
+    workspaceScope?: WorkspaceSelector | undefined;
+    /**
+     * Canonical name of the existing sandbox; this is not a rename or upsert.
+     *
+     * @generated from field: string name = 2;
+     */
+    name: string;
+    /**
+     * Nonempty OCI workload image reference. This does not change trusted runtime
+     * images or reseed an existing workspace.
+     *
+     * @generated from field: optional string image = 3;
+     */
+    image?: string | undefined;
+    /**
+     * Replace workload argv; an empty list restores image-resolved default shell behavior.
+     *
+     * @generated from field: openshell.v1.SandboxCommandUpdate command = 6;
+     */
+    command?: SandboxCommandUpdate | undefined;
+    /**
+     * Replace sandbox-level overrides. Empty clears overrides; template defaults remain.
+     *
+     * @generated from field: openshell.v1.SandboxMapUpdate environment = 7;
+     */
+    environment?: SandboxMapUpdate | undefined;
+    /**
+     * Replace user metadata, preserving gateway-owned keys. These do not set pod metadata.
+     *
+     * @generated from field: openshell.v1.SandboxMapUpdate labels = 8;
+     */
+    labels?: SandboxMapUpdate | undefined;
+    /**
+     * @generated from field: openshell.v1.SandboxMapUpdate annotations = 9;
+     */
+    annotations?: SandboxMapUpdate | undefined;
+    /**
+     * Required nonzero resource version read by the caller.
+     *
+     * @generated from field: uint64 expected_resource_version = 4;
+     */
+    expectedResourceVersion: bigint;
+    /**
+     * Optional nonzero UUID for durable at-most-once admission.
+     *
+     * @generated from field: string request_id = 5;
+     */
+    requestId: string;
+};
+/**
+ * Describes the message openshell.v1.UpdateSandboxRequest.
+ * Use `create(UpdateSandboxRequestSchema)` to create a new message.
+ */
+export declare const UpdateSandboxRequestSchema: GenMessage<UpdateSandboxRequest>;
+/**
+ * Presence selects replacement, including an explicitly empty list.
+ *
+ * @generated from message openshell.v1.SandboxCommandUpdate
+ */
+export type SandboxCommandUpdate = Message<"openshell.v1.SandboxCommandUpdate"> & {
+    /**
+     * @generated from field: repeated string argv = 1;
+     */
+    argv: string[];
+};
+/**
+ * Describes the message openshell.v1.SandboxCommandUpdate.
+ * Use `create(SandboxCommandUpdateSchema)` to create a new message.
+ */
+export declare const SandboxCommandUpdateSchema: GenMessage<SandboxCommandUpdate>;
+/**
+ * Presence selects replacement, including an explicitly empty map.
+ *
+ * @generated from message openshell.v1.SandboxMapUpdate
+ */
+export type SandboxMapUpdate = Message<"openshell.v1.SandboxMapUpdate"> & {
+    /**
+     * @generated from field: map<string, string> values = 1;
+     */
+    values: {
+        [key: string]: string;
+    };
+};
+/**
+ * Describes the message openshell.v1.SandboxMapUpdate.
+ * Use `create(SandboxMapUpdateSchema)` to create a new message.
+ */
+export declare const SandboxMapUpdateSchema: GenMessage<SandboxMapUpdate>;
 /**
  * @generated from message openshell.v1.CreateSandboxTemplateRequest
  */
@@ -1661,6 +1762,57 @@ export type StartSandboxRequest = Message<"openshell.v1.StartSandboxRequest"> &
  * Use `create(StartSandboxRequestSchema)` to create a new message.
  */
 export declare const StartSandboxRequestSchema: GenMessage<StartSandboxRequest>;
+/**
+ * Suspend sandbox request.
+ *
+ * @generated from message openshell.v1.SuspendSandboxRequest
+ */
+export type SuspendSandboxRequest = Message<"openshell.v1.SuspendSandboxRequest"> & {
+    /**
+     * Workspace scope. Only a named workspace selection is accepted.
+     *
+     * @generated from field: openshell.datamodel.v1.WorkspaceSelector workspace_scope = 2;
+     */
+    workspaceScope?: WorkspaceSelector | undefined;
+    /**
+     * @generated from field: string name = 1;
+     */
+    name: string;
+};
+/**
+ * Describes the message openshell.v1.SuspendSandboxRequest.
+ * Use `create(SuspendSandboxRequestSchema)` to create a new message.
+ */
+export declare const SuspendSandboxRequestSchema: GenMessage<SuspendSandboxRequest>;
+/**
+ * Resume sandbox request.
+ *
+ * @generated from message openshell.v1.ResumeSandboxRequest
+ */
+export type ResumeSandboxRequest = Message<"openshell.v1.ResumeSandboxRequest"> & {
+    /**
+     * Workspace scope. Only a named workspace selection is accepted.
+     *
+     * @generated from field: openshell.datamodel.v1.WorkspaceSelector workspace_scope = 2;
+     */
+    workspaceScope?: WorkspaceSelector | undefined;
+    /**
+     * @generated from field: string name = 1;
+     */
+    name: string;
+    /**
+     * If true, the isolation backend may boot the workload cleanly when it
+     * cannot restore the retained memory state. If false, resume fails instead.
+     *
+     * @generated from field: bool restart_if_restore_fails = 3;
+     */
+    restartIfRestoreFails: boolean;
+};
+/**
+ * Describes the message openshell.v1.ResumeSandboxRequest.
+ * Use `create(ResumeSandboxRequestSchema)` to create a new message.
+ */
+export declare const ResumeSandboxRequestSchema: GenMessage<ResumeSandboxRequest>;
 /**
  * Sandbox response.
  *
@@ -8442,7 +8594,20 @@ export declare enum SandboxPhase {
      *
      * @generated from enum value: SANDBOX_PHASE_COMPLETED = 9;
      */
-    COMPLETED = 9
+    COMPLETED = 9,
+    /**
+     * The gateway requested suspension and the driver has not confirmed it.
+     *
+     * @generated from enum value: SANDBOX_PHASE_SUSPENDING = 11;
+     */
+    SUSPENDING = 11,
+    /**
+     * The workload is frozen and its memory state is retained by the isolation
+     * backend. ResumeSandbox restores it; StartSandbox discards it.
+     *
+     * @generated from enum value: SANDBOX_PHASE_SUSPENDED = 12;
+     */
+    SUSPENDED = 12
 }
 /**
  * Describes the enum openshell.v1.SandboxPhase.
@@ -9371,6 +9536,28 @@ export declare const OpenShell: GenService<{
         input: typeof StartSandboxRequestSchema;
         output: typeof SandboxResponseSchema;
     };
+    /**
+     * Freeze a ready sandbox and retain its memory state for a later resume.
+     * Requires a compute driver and isolation backend that support state
+     * retention.
+     *
+     * @generated from rpc openshell.v1.OpenShell.SuspendSandbox
+     */
+    suspendSandbox: {
+        methodKind: "unary";
+        input: typeof SuspendSandboxRequestSchema;
+        output: typeof SandboxResponseSchema;
+    };
+    /**
+     * Restore a suspended sandbox in a new runtime generation.
+     *
+     * @generated from rpc openshell.v1.OpenShell.ResumeSandbox
+     */
+    resumeSandbox: {
+        methodKind: "unary";
+        input: typeof ResumeSandboxRequestSchema;
+        output: typeof SandboxResponseSchema;
+    };
     /**
      * Create a short-lived SSH session for a sandbox.
      *
@@ -10082,4 +10269,25 @@ export declare const OpenShell: GenService<{
         output: typeof ListWorkspaceMembersResponseSchema;
     };
 }>;
+/**
+ * Optional sandbox mutations are separate from OpenShell so existing generated
+ * OpenShell server implementations remain source-compatible.
+ *
+ * @generated from service openshell.v1.SandboxUpdates
+ */
+export declare const SandboxUpdates: GenService<{
+    /**
+     * Update the workload image, command, environment, labels, or annotations of a
+     * stopped sandbox while preserving its identity and retained storage. Requires
+     * compute-driver support for the selected changes and explicit gateway activation
+     * of sandbox updates.
+     *
+     * @generated from rpc openshell.v1.SandboxUpdates.UpdateSandbox
+     */
+    updateSandbox: {
+        methodKind: "unary";
+        input: typeof UpdateSandboxRequestSchema;
+        output: typeof SandboxResponseSchema;
+    };
+}>;
 //# sourceMappingURL=openshell_pb.d.ts.map