@leaflow/sdk 0.0.0-dev.451.gfd4baf5 → 0.0.0-dev.455.ge99314c

package/dist/proto/leaflow/fleet/host/v1/host_pb.d.ts

@@ -0,0 +1,619 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Any, Duration, Timestamp } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file leaflow/fleet/host/v1/host.proto.
+ */
+export declare const file_leaflow_fleet_host_v1_host: GenFile;
+/**
+ * A session on a machine.
+ *
+ * @generated from message leaflow.fleet.host.v1.Session
+ */
+export type Session = Message<"leaflow.fleet.host.v1.Session"> & {
+    /**
+     * Chosen by the service: 1 to 40 characters of [a-z0-9-], such as a UUID.
+     * The machine names files and sockets after it.
+     *
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+    /**
+     * The platform user who owns the session, which logind records as its
+     * RemoteUser.
+     *
+     * @generated from field: string user_id = 2;
+     */
+    userId: string;
+    /**
+     * The directory account (PAM_USER).
+     *
+     * @generated from field: string username = 3;
+     */
+    username: string;
+    /**
+     * The account's user id.
+     *
+     * @generated from field: uint32 uid = 4;
+     */
+    uid: number;
+    /**
+     * Where it is in its life.
+     *
+     * @generated from field: leaflow.fleet.host.v1.SessionState state = 5;
+     */
+    state: SessionState;
+    /**
+     * The logind session (XDG_SESSION_ID).
+     *
+     * @generated from field: string xdg_session_id = 6;
+     */
+    xdgSessionId: string;
+    /**
+     * When it was opened.
+     *
+     * @generated from field: google.protobuf.Timestamp created_at = 7;
+     */
+    createdAt?: Timestamp | undefined;
+    /**
+     * The last input of a person in the session. Informational.
+     *
+     * @generated from field: google.protobuf.Timestamp last_input_at = 8;
+     */
+    lastInputAt?: Timestamp | undefined;
+    /**
+     * Why the session ended. CLOSED only.
+     *
+     * @generated from field: leaflow.fleet.host.v1.SessionCloseReason close_reason = 10;
+     */
+    closeReason: SessionCloseReason;
+    /**
+     * Plain text for logs about close_reason, at most 1024 bytes.
+     *
+     * @generated from field: string reason_phrase = 11;
+     */
+    reasonPhrase: string;
+    /**
+     * The state of what its options added, at most one of each type, such as
+     * leaflow.fleet.virtualdesktop.host.v1 DesktopState. A type the service does
+     * not know is ignored.
+     *
+     * @generated from field: repeated google.protobuf.Any details = 12;
+     */
+    details: Any[];
+};
+/**
+ * Describes the message leaflow.fleet.host.v1.Session.
+ * Use `create(SessionSchema)` to create a new message.
+ */
+export declare const SessionSchema: GenMessage<Session>;
+/**
+ * Timeouts and limits of a session, which the daemon enforces even while the
+ * service is unreachable. A timeout that is unset or zero is off.
+ *
+ * @generated from message leaflow.fleet.host.v1.SessionPolicy
+ */
+export type SessionPolicy = Message<"leaflow.fleet.host.v1.SessionPolicy"> & {
+    /**
+     * Ends the session this long after its last participant left (xrdp
+     * DisconnectedTimeLimit).
+     *
+     * @generated from field: google.protobuf.Duration disconnected_timeout = 1;
+     */
+    disconnectedTimeout?: Duration | undefined;
+    /**
+     * Ends the session this long after it opened.
+     *
+     * @generated from field: google.protobuf.Duration max_lifetime = 2;
+     */
+    maxLifetime?: Duration | undefined;
+    /**
+     * Ends the session when no participant came this long after it opened.
+     *
+     * @generated from field: google.protobuf.Duration no_participant_timeout = 3;
+     */
+    noParticipantTimeout?: Duration | undefined;
+    /**
+     * Limits on the user's resources.
+     *
+     * @generated from field: leaflow.fleet.host.v1.ResourceControl resource_control = 4;
+     */
+    resourceControl?: ResourceControl | undefined;
+};
+/**
+ * Describes the message leaflow.fleet.host.v1.SessionPolicy.
+ * Use `create(SessionPolicySchema)` to create a new message.
+ */
+export declare const SessionPolicySchema: GenMessage<SessionPolicy>;
+/**
+ * Limits on the resources of the user's slice (user-UID.slice), as
+ * systemd.resource-control(5) properties. 0: not set.
+ *
+ * @generated from message leaflow.fleet.host.v1.ResourceControl
+ */
+export type ResourceControl = Message<"leaflow.fleet.host.v1.ResourceControl"> & {
+    /**
+     * MemoryHigh=, in bytes: where throttling starts.
+     *
+     * @generated from field: uint64 memory_high_bytes = 1;
+     */
+    memoryHighBytes: bigint;
+    /**
+     * MemoryMax=, in bytes: the hard limit.
+     *
+     * @generated from field: uint64 memory_max_bytes = 2;
+     */
+    memoryMaxBytes: bigint;
+    /**
+     * CPUWeight=, 1 to 10000.
+     *
+     * @generated from field: uint32 cpu_weight = 3;
+     */
+    cpuWeight: number;
+    /**
+     * CPUQuota=, in percent of one CPU; above 100 on several CPUs.
+     *
+     * @generated from field: uint32 cpu_quota_percent = 4;
+     */
+    cpuQuotaPercent: number;
+    /**
+     * TasksMax=.
+     *
+     * @generated from field: uint32 tasks_max = 5;
+     */
+    tasksMax: number;
+};
+/**
+ * Describes the message leaflow.fleet.host.v1.ResourceControl.
+ * Use `create(ResourceControlSchema)` to create a new message.
+ */
+export declare const ResourceControlSchema: GenMessage<ResourceControl>;
+/**
+ * The request of OpenSession.
+ *
+ * @generated from message leaflow.fleet.host.v1.OpenSessionRequest
+ */
+export type OpenSessionRequest = Message<"leaflow.fleet.host.v1.OpenSessionRequest"> & {
+    /**
+     * The id of the new session, in the format of Session.session_id.
+     *
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+    /**
+     * The platform user who will own it.
+     *
+     * @generated from field: string user_id = 2;
+     */
+    userId: string;
+    /**
+     * The platform user's directory account. The daemon only checks that the
+     * account may have a session.
+     *
+     * @generated from field: string username = 3;
+     */
+    username: string;
+    /**
+     * The address of the participant that asked, for PAM_RHOST and logind's
+     * RemoteHost. Empty: the service's host name, so that the session is
+     * always remote.
+     *
+     * @generated from field: string remote_host = 4;
+     */
+    remoteHost: string;
+    /**
+     * Timeouts and limits.
+     *
+     * @generated from field: leaflow.fleet.host.v1.SessionPolicy policy = 5;
+     */
+    policy?: SessionPolicy | undefined;
+    /**
+     * What the session has besides the session layer, at most one of each
+     * type, such as leaflow.fleet.virtualdesktop.host.v1 DesktopOptions. None: a
+     * session without a desktop.
+     *
+     * @generated from field: repeated google.protobuf.Any options = 6;
+     */
+    options: Any[];
+};
+/**
+ * Describes the message leaflow.fleet.host.v1.OpenSessionRequest.
+ * Use `create(OpenSessionRequestSchema)` to create a new message.
+ */
+export declare const OpenSessionRequestSchema: GenMessage<OpenSessionRequest>;
+/**
+ * The response of OpenSession.
+ *
+ * @generated from message leaflow.fleet.host.v1.OpenSessionResponse
+ */
+export type OpenSessionResponse = Message<"leaflow.fleet.host.v1.OpenSessionResponse"> & {
+    /**
+     * The session, OPEN.
+     *
+     * @generated from field: leaflow.fleet.host.v1.Session session = 1;
+     */
+    session?: Session | undefined;
+};
+/**
+ * Describes the message leaflow.fleet.host.v1.OpenSessionResponse.
+ * Use `create(OpenSessionResponseSchema)` to create a new message.
+ */
+export declare const OpenSessionResponseSchema: GenMessage<OpenSessionResponse>;
+/**
+ * The request of CloseSession.
+ *
+ * @generated from message leaflow.fleet.host.v1.CloseSessionRequest
+ */
+export type CloseSessionRequest = Message<"leaflow.fleet.host.v1.CloseSessionRequest"> & {
+    /**
+     * The session.
+     *
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+    /**
+     * How long programs get to exit after SIGTERM. Unset: the daemon's
+     * default.
+     *
+     * @generated from field: google.protobuf.Duration grace_period = 2;
+     */
+    gracePeriod?: Duration | undefined;
+};
+/**
+ * Describes the message leaflow.fleet.host.v1.CloseSessionRequest.
+ * Use `create(CloseSessionRequestSchema)` to create a new message.
+ */
+export declare const CloseSessionRequestSchema: GenMessage<CloseSessionRequest>;
+/**
+ * The response of CloseSession.
+ *
+ * @generated from message leaflow.fleet.host.v1.CloseSessionResponse
+ */
+export type CloseSessionResponse = Message<"leaflow.fleet.host.v1.CloseSessionResponse"> & {};
+/**
+ * Describes the message leaflow.fleet.host.v1.CloseSessionResponse.
+ * Use `create(CloseSessionResponseSchema)` to create a new message.
+ */
+export declare const CloseSessionResponseSchema: GenMessage<CloseSessionResponse>;
+/**
+ * The request of TerminateSession.
+ *
+ * @generated from message leaflow.fleet.host.v1.TerminateSessionRequest
+ */
+export type TerminateSessionRequest = Message<"leaflow.fleet.host.v1.TerminateSessionRequest"> & {
+    /**
+     * The session.
+     *
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+};
+/**
+ * Describes the message leaflow.fleet.host.v1.TerminateSessionRequest.
+ * Use `create(TerminateSessionRequestSchema)` to create a new message.
+ */
+export declare const TerminateSessionRequestSchema: GenMessage<TerminateSessionRequest>;
+/**
+ * The response of TerminateSession.
+ *
+ * @generated from message leaflow.fleet.host.v1.TerminateSessionResponse
+ */
+export type TerminateSessionResponse = Message<"leaflow.fleet.host.v1.TerminateSessionResponse"> & {};
+/**
+ * Describes the message leaflow.fleet.host.v1.TerminateSessionResponse.
+ * Use `create(TerminateSessionResponseSchema)` to create a new message.
+ */
+export declare const TerminateSessionResponseSchema: GenMessage<TerminateSessionResponse>;
+/**
+ * The request of ReportSessions.
+ *
+ * @generated from message leaflow.fleet.host.v1.ReportSessionsRequest
+ */
+export type ReportSessionsRequest = Message<"leaflow.fleet.host.v1.ReportSessionsRequest"> & {
+    /**
+     * /proc/sys/kernel/random/boot_id, new on every boot.
+     *
+     * @generated from field: string boot_id = 1;
+     */
+    bootId: string;
+    /**
+     * Every session since the machine booted, closed ones included until a
+     * report that carried them closed was answered with success.
+     *
+     * @generated from field: repeated leaflow.fleet.host.v1.Session sessions = 2;
+     */
+    sessions: Session[];
+    /**
+     * Orders the reports the daemon sends on this connection by when it
+     * observed what they report (leaflow.fleet.control.v1 Reports): it
+     * increases with every report, 1 for the first, and a report sent again
+     * keeps its sequence.
+     *
+     * @generated from field: uint64 sequence = 3;
+     */
+    sequence: bigint;
+};
+/**
+ * Describes the message leaflow.fleet.host.v1.ReportSessionsRequest.
+ * Use `create(ReportSessionsRequestSchema)` to create a new message.
+ */
+export declare const ReportSessionsRequestSchema: GenMessage<ReportSessionsRequest>;
+/**
+ * The response of ReportSessions.
+ *
+ * @generated from message leaflow.fleet.host.v1.ReportSessionsResponse
+ */
+export type ReportSessionsResponse = Message<"leaflow.fleet.host.v1.ReportSessionsResponse"> & {};
+/**
+ * Describes the message leaflow.fleet.host.v1.ReportSessionsResponse.
+ * Use `create(ReportSessionsResponseSchema)` to create a new message.
+ */
+export declare const ReportSessionsResponseSchema: GenMessage<ReportSessionsResponse>;
+/**
+ * The request of ReportSessionState.
+ *
+ * @generated from message leaflow.fleet.host.v1.ReportSessionStateRequest
+ */
+export type ReportSessionStateRequest = Message<"leaflow.fleet.host.v1.ReportSessionStateRequest"> & {
+    /**
+     * The session as it is now. Its user_id must be the one the service holds
+     * for it.
+     *
+     * @generated from field: leaflow.fleet.host.v1.Session session = 1;
+     */
+    session?: Session | undefined;
+    /**
+     * Orders the reports the daemon sends on this connection by when it
+     * observed what they report (leaflow.fleet.control.v1 Reports): it
+     * increases with every report, 1 for the first, and a report sent again
+     * keeps its sequence.
+     *
+     * @generated from field: uint64 sequence = 2;
+     */
+    sequence: bigint;
+};
+/**
+ * Describes the message leaflow.fleet.host.v1.ReportSessionStateRequest.
+ * Use `create(ReportSessionStateRequestSchema)` to create a new message.
+ */
+export declare const ReportSessionStateRequestSchema: GenMessage<ReportSessionStateRequest>;
+/**
+ * The response of ReportSessionState.
+ *
+ * @generated from message leaflow.fleet.host.v1.ReportSessionStateResponse
+ */
+export type ReportSessionStateResponse = Message<"leaflow.fleet.host.v1.ReportSessionStateResponse"> & {};
+/**
+ * Describes the message leaflow.fleet.host.v1.ReportSessionStateResponse.
+ * Use `create(ReportSessionStateResponseSchema)` to create a new message.
+ */
+export declare const ReportSessionStateResponseSchema: GenMessage<ReportSessionStateResponse>;
+/**
+ * Where a session is in its life.
+ *
+ * @generated from enum leaflow.fleet.host.v1.SessionState
+ */
+export declare enum SessionState {
+    /**
+     * @generated from enum value: SESSION_STATE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * The PAM session opens and the session process starts.
+     *
+     * @generated from enum value: SESSION_STATE_OPENING = 1;
+     */
+    OPENING = 1,
+    /**
+     * Logged in: the session runs.
+     *
+     * @generated from enum value: SESSION_STATE_OPEN = 2;
+     */
+    OPEN = 2,
+    /**
+     * Logged out; its processes are being cleaned up.
+     *
+     * @generated from enum value: SESSION_STATE_CLOSING = 4;
+     */
+    CLOSING = 4,
+    /**
+     * Gone.
+     *
+     * @generated from enum value: SESSION_STATE_CLOSED = 5;
+     */
+    CLOSED = 5
+}
+/**
+ * Describes the enum leaflow.fleet.host.v1.SessionState.
+ */
+export declare const SessionStateSchema: GenEnum<SessionState>;
+/**
+ * Why a session ended.
+ *
+ * @generated from enum leaflow.fleet.host.v1.SessionCloseReason
+ */
+export declare enum SessionCloseReason {
+    /**
+     * @generated from enum value: SESSION_CLOSE_REASON_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * CloseSession was called.
+     *
+     * @generated from enum value: SESSION_CLOSE_REASON_CLOSE_REQUESTED = 1;
+     */
+    CLOSE_REQUESTED = 1,
+    /**
+     * TerminateSession was called.
+     *
+     * @generated from enum value: SESSION_CLOSE_REASON_TERMINATE_REQUESTED = 2;
+     */
+    TERMINATE_REQUESTED = 2,
+    /**
+     * The user logged out, such as when the shell of a terminal session
+     * exited.
+     *
+     * @generated from enum value: SESSION_CLOSE_REASON_LOGOUT = 3;
+     */
+    LOGOUT = 3,
+    /**
+     * SessionPolicy.disconnected_timeout passed.
+     *
+     * @generated from enum value: SESSION_CLOSE_REASON_DISCONNECTED_TIMEOUT = 4;
+     */
+    DISCONNECTED_TIMEOUT = 4,
+    /**
+     * SessionPolicy.no_participant_timeout passed.
+     *
+     * @generated from enum value: SESSION_CLOSE_REASON_NO_PARTICIPANT_TIMEOUT = 5;
+     */
+    NO_PARTICIPANT_TIMEOUT = 5,
+    /**
+     * SessionPolicy.max_lifetime passed.
+     *
+     * @generated from enum value: SESSION_CLOSE_REASON_MAX_LIFETIME = 6;
+     */
+    MAX_LIFETIME = 6,
+    /**
+     * What an option added and the session cannot go on without exited
+     * unexpectedly, such as the X server of a desktop.
+     *
+     * @generated from enum value: SESSION_CLOSE_REASON_DISPLAY_EXIT = 7;
+     */
+    DISPLAY_EXIT = 7,
+    /**
+     * The session process died, and the daemon cleaned up what was left.
+     *
+     * @generated from enum value: SESSION_CLOSE_REASON_PROCESS_LOST = 8;
+     */
+    PROCESS_LOST = 8,
+    /**
+     * Opening failed and was undone.
+     *
+     * @generated from enum value: SESSION_CLOSE_REASON_OPEN_FAILED = 9;
+     */
+    OPEN_FAILED = 9,
+    /**
+     * The account may no longer log in to the machine.
+     *
+     * @generated from enum value: SESSION_CLOSE_REASON_ACCESS_REVOKED = 10;
+     */
+    ACCESS_REVOKED = 10
+}
+/**
+ * Describes the enum leaflow.fleet.host.v1.SessionCloseReason.
+ */
+export declare const SessionCloseReasonSchema: GenEnum<SessionCloseReason>;
+/**
+ * Opens and ends the sessions of a machine. Served by the daemon on its
+ * control connection; the service calls it.
+ *
+ * @generated from service leaflow.fleet.host.v1.SessionHostService
+ */
+export declare const SessionHostService: GenService<{
+    /**
+     * Opens a session for a platform user, as the user's directory account,
+     * and returns once it is ready: its session process started, with what
+     * its options add, such as the X server of a desktop. On a machine, an
+     * account has at most one session with a desktop, since a desktop's
+     * per-user services exist once per account, and at most 8 sessions in all:
+     * sessions without a desktop run side by side, such as one for a program
+     * and one for a person. Calling again with the session_id of an open
+     * session of the same user returns that session.
+     *
+     * Fails with:
+     *   - INVALID_ARGUMENT and reason INVALID_REQUEST for an option of a type
+     *     the Agent does not know or one given twice;
+     *   - FAILED_PRECONDITION and reason FEATURE_UNAVAILABLE for an option of
+     *     a feature the machine does not report available, with metadata
+     *     "feature", the feature's name;
+     *   - NOT_FOUND and reason USER_NOT_FOUND for an account the machine's
+     *     copy of the directory does not hold;
+     *   - PERMISSION_DENIED and reason USER_NOT_ALLOWED for an account that
+     *     may not log in to the machine, one the machine does not serve (a
+     *     conflict) or one outside the groups the machine allows sessions;
+     *   - PERMISSION_DENIED and reason ACCOUNT_EXPIRED when PAM reports the
+     *     account expired (PAM_ACCT_EXPIRED);
+     *   - PERMISSION_DENIED and reason PAM_PERMISSION_DENIED when PAM refuses
+     *     the account or the session (PAM_PERM_DENIED), with metadata
+     *     "pamMessage", the text PAM gave;
+     *   - ALREADY_EXISTS and reason USER_HAS_DESKTOP_SESSION for a session
+     *     with a desktop when the user has one with another id, with metadata
+     *     "sessionId";
+     *   - FAILED_PRECONDITION and reason SESSION_LIMIT_REACHED when the user
+     *     has 8 open sessions on the machine;
+     *   - ALREADY_EXISTS and reason SESSION_ID_CONFLICT when another user's
+     *     session has the id;
+     *   - INTERNAL and reason SESSION_START_FAILED when the session process or
+     *     what its options add failed to start; what had started was undone;
+     *   - the reasons the package of an option lists.
+     * A call without a timeout may run 120 seconds.
+     *
+     * @generated from rpc leaflow.fleet.host.v1.SessionHostService.OpenSession
+     */
+    openSession: {
+        methodKind: "unary";
+        input: typeof OpenSessionRequestSchema;
+        output: typeof OpenSessionResponseSchema;
+    };
+    /**
+     * Ends a session in order: its programs get SIGTERM and grace_period to
+     * exit, then the session is terminated. Answers once the session is
+     * CLOSED, and at once for one already closed.
+     *
+     * Fails with NOT_FOUND and reason SESSION_NOT_FOUND for a session that
+     * never existed on the machine since it booted.
+     *
+     * @generated from rpc leaflow.fleet.host.v1.SessionHostService.CloseSession
+     */
+    closeSession: {
+        methodKind: "unary";
+        input: typeof CloseSessionRequestSchema;
+        output: typeof CloseSessionResponseSchema;
+    };
+    /**
+     * Ends a session at once, killing every process in it (logind
+     * TerminateSession). Answers once the session is CLOSED, and at once for
+     * one already closed.
+     *
+     * Fails with NOT_FOUND and reason SESSION_NOT_FOUND for a session that
+     * never existed on the machine since it booted.
+     *
+     * @generated from rpc leaflow.fleet.host.v1.SessionHostService.TerminateSession
+     */
+    terminateSession: {
+        methodKind: "unary";
+        input: typeof TerminateSessionRequestSchema;
+        output: typeof TerminateSessionResponseSchema;
+    };
+}>;
+/**
+ * Takes the reports of a machine's sessions. Served by the service on daemon
+ * connections.
+ *
+ * @generated from service leaflow.fleet.host.v1.SessionRegistryService
+ */
+export declare const SessionRegistryService: GenService<{
+    /**
+     * Reports every session of the machine.
+     *
+     * @generated from rpc leaflow.fleet.host.v1.SessionRegistryService.ReportSessions
+     */
+    reportSessions: {
+        methodKind: "unary";
+        input: typeof ReportSessionsRequestSchema;
+        output: typeof ReportSessionsResponseSchema;
+    };
+    /**
+     * Reports that a session changed state. Only for a session the service
+     * opened or saw in a full report.
+     * CLOSED is final: later reports of the session are ignored.
+     *
+     * @generated from rpc leaflow.fleet.host.v1.SessionRegistryService.ReportSessionState
+     */
+    reportSessionState: {
+        methodKind: "unary";
+        input: typeof ReportSessionStateRequestSchema;
+        output: typeof ReportSessionStateResponseSchema;
+    };
+}>;