@toshicloud/sdk 0.0.0-stage → 0.3.0

package/dist/gen/toshi/workspace/v1/display_pb.d.ts

@@ -0,0 +1,1166 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Duration, DurationJson, Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file toshi/workspace/v1/display.proto.
+ */
+export declare const file_toshi_workspace_v1_display: GenFile;
+/**
+ * @generated from message toshi.workspace.v1.DisplaySession
+ */
+export type DisplaySession = Message<"toshi.workspace.v1.DisplaySession"> & {
+    /**
+     * Assigned by the server; unique within the workspace.
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * The job the session views: its ID as the jobs API and `toshi host-job
+     * list` show it.
+     *
+     * @generated from field: string job_id = 2;
+     */
+    jobId: string;
+    /**
+     * @generated from field: toshi.workspace.v1.DisplayMode mode = 3;
+     */
+    mode: DisplayMode;
+    /**
+     * For an agent's run: whether a person may take the input from the
+     * agent. Recorded; takeover itself is not served yet.
+     *
+     * @generated from field: bool allow_takeover = 4;
+     */
+    allowTakeover: boolean;
+    /**
+     * The session ends once no bytes of the screen's protocol have gone
+     * either way for this long.
+     *
+     * @generated from field: google.protobuf.Duration idle_close = 5;
+     */
+    idleClose?: Duration | undefined;
+    /**
+     * @generated from field: toshi.workspace.v1.DisplaySessionState state = 6;
+     */
+    state: DisplaySessionState;
+    /**
+     * @generated from field: toshi.workspace.v1.DisplayOpener opened_by = 7;
+     */
+    openedBy: DisplayOpener;
+    /**
+     * @generated from field: google.protobuf.Timestamp opened_at = 8;
+     */
+    openedAt?: Timestamp | undefined;
+    /**
+     * When the token expires: a session not attached by then closes.
+     *
+     * @generated from field: google.protobuf.Timestamp attach_by = 9;
+     */
+    attachBy?: Timestamp | undefined;
+    /**
+     * Unset until the viewer attaches.
+     *
+     * @generated from field: google.protobuf.Timestamp attached_at = 10;
+     */
+    attachedAt?: Timestamp | undefined;
+    /**
+     * Unset while the session is open.
+     *
+     * @generated from field: google.protobuf.Timestamp closed_at = 11;
+     */
+    closedAt?: Timestamp | undefined;
+    /**
+     * Why it closed: closed, idle, expired, suspended, ended (its job
+     * stopped running where the session was opened), protocol_error (the
+     * viewer sent what the relay does not accept), unavailable (the job's
+     * host did not open the screen) or shutdown (the control plane
+     * stopped). Empty while it is open.
+     *
+     * @generated from field: string close_reason = 12;
+     */
+    closeReason: string;
+    /**
+     * Who opened it, as the audit log names the caller: the GitHub login of
+     * the signed-in person for DISPLAY_OPENER_PERSON, the API token's id for
+     * DISPLAY_OPENER_PROGRAM.
+     *
+     * @generated from field: string opener_id = 13;
+     */
+    openerId: string;
+    /**
+     * The web origin of the call that opened it, for example
+     * "https://toshi.example.com"; empty for a call that sent none.
+     *
+     * @generated from field: string origin = 14;
+     */
+    origin: string;
+    /**
+     * The id (jti) of the one token that attaches the session: an id, never
+     * the token.
+     *
+     * @generated from field: string attach_token_id = 15;
+     */
+    attachTokenId: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.DisplaySession
+ */
+export type DisplaySessionJson = {
+    /**
+     * Assigned by the server; unique within the workspace.
+     *
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+    /**
+     * The job the session views: its ID as the jobs API and `toshi host-job
+     * list` show it.
+     *
+     * @generated from field: string job_id = 2;
+     */
+    jobId?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.DisplayMode mode = 3;
+     */
+    mode?: DisplayModeJson;
+    /**
+     * For an agent's run: whether a person may take the input from the
+     * agent. Recorded; takeover itself is not served yet.
+     *
+     * @generated from field: bool allow_takeover = 4;
+     */
+    allowTakeover?: boolean;
+    /**
+     * The session ends once no bytes of the screen's protocol have gone
+     * either way for this long.
+     *
+     * @generated from field: google.protobuf.Duration idle_close = 5;
+     */
+    idleClose?: DurationJson;
+    /**
+     * @generated from field: toshi.workspace.v1.DisplaySessionState state = 6;
+     */
+    state?: DisplaySessionStateJson;
+    /**
+     * @generated from field: toshi.workspace.v1.DisplayOpener opened_by = 7;
+     */
+    openedBy?: DisplayOpenerJson;
+    /**
+     * @generated from field: google.protobuf.Timestamp opened_at = 8;
+     */
+    openedAt?: TimestampJson;
+    /**
+     * When the token expires: a session not attached by then closes.
+     *
+     * @generated from field: google.protobuf.Timestamp attach_by = 9;
+     */
+    attachBy?: TimestampJson;
+    /**
+     * Unset until the viewer attaches.
+     *
+     * @generated from field: google.protobuf.Timestamp attached_at = 10;
+     */
+    attachedAt?: TimestampJson;
+    /**
+     * Unset while the session is open.
+     *
+     * @generated from field: google.protobuf.Timestamp closed_at = 11;
+     */
+    closedAt?: TimestampJson;
+    /**
+     * Why it closed: closed, idle, expired, suspended, ended (its job
+     * stopped running where the session was opened), protocol_error (the
+     * viewer sent what the relay does not accept), unavailable (the job's
+     * host did not open the screen) or shutdown (the control plane
+     * stopped). Empty while it is open.
+     *
+     * @generated from field: string close_reason = 12;
+     */
+    closeReason?: string;
+    /**
+     * Who opened it, as the audit log names the caller: the GitHub login of
+     * the signed-in person for DISPLAY_OPENER_PERSON, the API token's id for
+     * DISPLAY_OPENER_PROGRAM.
+     *
+     * @generated from field: string opener_id = 13;
+     */
+    openerId?: string;
+    /**
+     * The web origin of the call that opened it, for example
+     * "https://toshi.example.com"; empty for a call that sent none.
+     *
+     * @generated from field: string origin = 14;
+     */
+    origin?: string;
+    /**
+     * The id (jti) of the one token that attaches the session: an id, never
+     * the token.
+     *
+     * @generated from field: string attach_token_id = 15;
+     */
+    attachTokenId?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.DisplaySession.
+ * Use `create(DisplaySessionSchema)` to create a new message.
+ */
+export declare const DisplaySessionSchema: GenMessage<DisplaySession, {
+    jsonType: DisplaySessionJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.OpenDisplaySessionRequest
+ */
+export type OpenDisplaySessionRequest = Message<"toshi.workspace.v1.OpenDisplaySessionRequest"> & {
+    /**
+     * What to view. A job runs on a host and has a screen; a workload of
+     * WorkloadService has none yet and fails with FAILED_PRECONDITION.
+     *
+     * @generated from oneof toshi.workspace.v1.OpenDisplaySessionRequest.target
+     */
+    target: {
+        /**
+         * @generated from field: string job_id = 1;
+         */
+        value: string;
+        case: "jobId";
+    } | {
+        /**
+         * @generated from field: string workload_id = 2;
+         */
+        value: string;
+        case: "workloadId";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+    /**
+     * @generated from field: toshi.workspace.v1.DisplayMode mode = 3;
+     */
+    mode: DisplayMode;
+    /**
+     * The idle close, at most the plan's; unset is the plan's.
+     *
+     * @generated from field: google.protobuf.Duration idle_close = 4;
+     */
+    idleClose?: Duration | undefined;
+    /**
+     * @generated from field: bool allow_takeover = 5;
+     */
+    allowTakeover: boolean;
+    /**
+     * @generated from field: string request_key = 6;
+     */
+    requestKey: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.OpenDisplaySessionRequest
+ */
+export type OpenDisplaySessionRequestJson = {
+    /**
+     * @generated from field: string job_id = 1;
+     */
+    jobId?: string;
+    /**
+     * @generated from field: string workload_id = 2;
+     */
+    workloadId?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.DisplayMode mode = 3;
+     */
+    mode?: DisplayModeJson;
+    /**
+     * The idle close, at most the plan's; unset is the plan's.
+     *
+     * @generated from field: google.protobuf.Duration idle_close = 4;
+     */
+    idleClose?: DurationJson;
+    /**
+     * @generated from field: bool allow_takeover = 5;
+     */
+    allowTakeover?: boolean;
+    /**
+     * @generated from field: string request_key = 6;
+     */
+    requestKey?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.OpenDisplaySessionRequest.
+ * Use `create(OpenDisplaySessionRequestSchema)` to create a new message.
+ */
+export declare const OpenDisplaySessionRequestSchema: GenMessage<OpenDisplaySessionRequest, {
+    jsonType: OpenDisplaySessionRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.OpenDisplaySessionResponse
+ */
+export type OpenDisplaySessionResponse = Message<"toshi.workspace.v1.OpenDisplaySessionResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.DisplaySession session = 1;
+     */
+    session?: DisplaySession | undefined;
+    /**
+     * The session's WebSocket URL path, on the control plane's address:
+     * /display/<id>.
+     *
+     * @generated from field: string url = 2;
+     */
+    url: string;
+    /**
+     * The token that attaches the session, once, before
+     * session.attach_by. The viewer sends it as a WebSocket subprotocol,
+     * toshi.display.<token>, beside the subprotocol binary. Empty on a
+     * retry.
+     *
+     * @generated from field: string token = 3;
+     */
+    token: string;
+    /**
+     * Set when this answers a retry of the call that opened the session:
+     * nothing was opened and no token is returned.
+     *
+     * @generated from field: bool replayed = 4;
+     */
+    replayed: boolean;
+};
+/**
+ * @generated from message toshi.workspace.v1.OpenDisplaySessionResponse
+ */
+export type OpenDisplaySessionResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.DisplaySession session = 1;
+     */
+    session?: DisplaySessionJson;
+    /**
+     * The session's WebSocket URL path, on the control plane's address:
+     * /display/<id>.
+     *
+     * @generated from field: string url = 2;
+     */
+    url?: string;
+    /**
+     * The token that attaches the session, once, before
+     * session.attach_by. The viewer sends it as a WebSocket subprotocol,
+     * toshi.display.<token>, beside the subprotocol binary. Empty on a
+     * retry.
+     *
+     * @generated from field: string token = 3;
+     */
+    token?: string;
+    /**
+     * Set when this answers a retry of the call that opened the session:
+     * nothing was opened and no token is returned.
+     *
+     * @generated from field: bool replayed = 4;
+     */
+    replayed?: boolean;
+};
+/**
+ * Describes the message toshi.workspace.v1.OpenDisplaySessionResponse.
+ * Use `create(OpenDisplaySessionResponseSchema)` to create a new message.
+ */
+export declare const OpenDisplaySessionResponseSchema: GenMessage<OpenDisplaySessionResponse, {
+    jsonType: OpenDisplaySessionResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.GetDisplaySessionRequest
+ */
+export type GetDisplaySessionRequest = Message<"toshi.workspace.v1.GetDisplaySessionRequest"> & {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.GetDisplaySessionRequest
+ */
+export type GetDisplaySessionRequestJson = {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.GetDisplaySessionRequest.
+ * Use `create(GetDisplaySessionRequestSchema)` to create a new message.
+ */
+export declare const GetDisplaySessionRequestSchema: GenMessage<GetDisplaySessionRequest, {
+    jsonType: GetDisplaySessionRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.GetDisplaySessionResponse
+ */
+export type GetDisplaySessionResponse = Message<"toshi.workspace.v1.GetDisplaySessionResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.DisplaySession session = 1;
+     */
+    session?: DisplaySession | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.GetDisplaySessionResponse
+ */
+export type GetDisplaySessionResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.DisplaySession session = 1;
+     */
+    session?: DisplaySessionJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.GetDisplaySessionResponse.
+ * Use `create(GetDisplaySessionResponseSchema)` to create a new message.
+ */
+export declare const GetDisplaySessionResponseSchema: GenMessage<GetDisplaySessionResponse, {
+    jsonType: GetDisplaySessionResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListDisplaySessionsRequest
+ */
+export type ListDisplaySessionsRequest = Message<"toshi.workspace.v1.ListDisplaySessionsRequest"> & {
+    /**
+     * Only this job's sessions; empty lists every job's.
+     *
+     * @generated from field: string job_id = 1;
+     */
+    jobId: string;
+    /**
+     * Only the sessions that have not closed.
+     *
+     * @generated from field: bool open_only = 2;
+     */
+    openOnly: boolean;
+    /**
+     * The most sessions in one page; zero lets the server choose.
+     *
+     * @generated from field: int32 page_size = 3;
+     */
+    pageSize: number;
+    /**
+     * From an earlier response's next_page_token; empty for the first page.
+     *
+     * @generated from field: string page_token = 4;
+     */
+    pageToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.ListDisplaySessionsRequest
+ */
+export type ListDisplaySessionsRequestJson = {
+    /**
+     * Only this job's sessions; empty lists every job's.
+     *
+     * @generated from field: string job_id = 1;
+     */
+    jobId?: string;
+    /**
+     * Only the sessions that have not closed.
+     *
+     * @generated from field: bool open_only = 2;
+     */
+    openOnly?: boolean;
+    /**
+     * The most sessions in one page; zero lets the server choose.
+     *
+     * @generated from field: int32 page_size = 3;
+     */
+    pageSize?: number;
+    /**
+     * From an earlier response's next_page_token; empty for the first page.
+     *
+     * @generated from field: string page_token = 4;
+     */
+    pageToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ListDisplaySessionsRequest.
+ * Use `create(ListDisplaySessionsRequestSchema)` to create a new message.
+ */
+export declare const ListDisplaySessionsRequestSchema: GenMessage<ListDisplaySessionsRequest, {
+    jsonType: ListDisplaySessionsRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListDisplaySessionsResponse
+ */
+export type ListDisplaySessionsResponse = Message<"toshi.workspace.v1.ListDisplaySessionsResponse"> & {
+    /**
+     * @generated from field: repeated toshi.workspace.v1.DisplaySession sessions = 1;
+     */
+    sessions: DisplaySession[];
+    /**
+     * Empty on the last page.
+     *
+     * @generated from field: string next_page_token = 2;
+     */
+    nextPageToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.ListDisplaySessionsResponse
+ */
+export type ListDisplaySessionsResponseJson = {
+    /**
+     * @generated from field: repeated toshi.workspace.v1.DisplaySession sessions = 1;
+     */
+    sessions?: DisplaySessionJson[];
+    /**
+     * Empty on the last page.
+     *
+     * @generated from field: string next_page_token = 2;
+     */
+    nextPageToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ListDisplaySessionsResponse.
+ * Use `create(ListDisplaySessionsResponseSchema)` to create a new message.
+ */
+export declare const ListDisplaySessionsResponseSchema: GenMessage<ListDisplaySessionsResponse, {
+    jsonType: ListDisplaySessionsResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.CloseDisplaySessionRequest
+ */
+export type CloseDisplaySessionRequest = Message<"toshi.workspace.v1.CloseDisplaySessionRequest"> & {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.CloseDisplaySessionRequest
+ */
+export type CloseDisplaySessionRequestJson = {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.CloseDisplaySessionRequest.
+ * Use `create(CloseDisplaySessionRequestSchema)` to create a new message.
+ */
+export declare const CloseDisplaySessionRequestSchema: GenMessage<CloseDisplaySessionRequest, {
+    jsonType: CloseDisplaySessionRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.CloseDisplaySessionResponse
+ */
+export type CloseDisplaySessionResponse = Message<"toshi.workspace.v1.CloseDisplaySessionResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.DisplaySession session = 1;
+     */
+    session?: DisplaySession | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.CloseDisplaySessionResponse
+ */
+export type CloseDisplaySessionResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.DisplaySession session = 1;
+     */
+    session?: DisplaySessionJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.CloseDisplaySessionResponse.
+ * Use `create(CloseDisplaySessionResponseSchema)` to create a new message.
+ */
+export declare const CloseDisplaySessionResponseSchema: GenMessage<CloseDisplaySessionResponse, {
+    jsonType: CloseDisplaySessionResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.SendDisplayKeysRequest
+ */
+export type SendDisplayKeysRequest = Message<"toshi.workspace.v1.SendDisplayKeysRequest"> & {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+    /**
+     * @generated from oneof toshi.workspace.v1.SendDisplayKeysRequest.input
+     */
+    input: {
+        /**
+         * Text typed one character at a time, at most 4096 characters of
+         * printable ASCII, newlines ("\n") and tabs; any other character fails
+         * the call with INVALID_ARGUMENT before any key is sent. A character
+         * that needs Shift on a US keyboard is typed with it; a newline is
+         * Return.
+         *
+         * @generated from field: string text = 2;
+         */
+        value: string;
+        case: "text";
+    } | {
+        /**
+         * Keys pressed in order, at most 256, each a key or a chord such as
+         * "Return", "ctrl+c", "ctrl+alt+t" or "shift+Tab": modifiers (ctrl,
+         * shift, alt, super) go down in order, then the key goes down and up,
+         * then the modifiers go up. A key is one character or an X11 keysym
+         * name: Return, Tab, Escape, BackSpace, Delete, Insert, Home, End,
+         * Page_Up, Page_Down, Left, Up, Right, Down, space, F1 to F12. An
+         * unknown key fails the call with INVALID_ARGUMENT before any key is
+         * sent.
+         *
+         * @generated from field: toshi.workspace.v1.DisplayKeys keys = 3;
+         */
+        value: DisplayKeys;
+        case: "keys";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * @generated from message toshi.workspace.v1.SendDisplayKeysRequest
+ */
+export type SendDisplayKeysRequestJson = {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId?: string;
+    /**
+     * Text typed one character at a time, at most 4096 characters of
+     * printable ASCII, newlines ("\n") and tabs; any other character fails
+     * the call with INVALID_ARGUMENT before any key is sent. A character
+     * that needs Shift on a US keyboard is typed with it; a newline is
+     * Return.
+     *
+     * @generated from field: string text = 2;
+     */
+    text?: string;
+    /**
+     * Keys pressed in order, at most 256, each a key or a chord such as
+     * "Return", "ctrl+c", "ctrl+alt+t" or "shift+Tab": modifiers (ctrl,
+     * shift, alt, super) go down in order, then the key goes down and up,
+     * then the modifiers go up. A key is one character or an X11 keysym
+     * name: Return, Tab, Escape, BackSpace, Delete, Insert, Home, End,
+     * Page_Up, Page_Down, Left, Up, Right, Down, space, F1 to F12. An
+     * unknown key fails the call with INVALID_ARGUMENT before any key is
+     * sent.
+     *
+     * @generated from field: toshi.workspace.v1.DisplayKeys keys = 3;
+     */
+    keys?: DisplayKeysJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.SendDisplayKeysRequest.
+ * Use `create(SendDisplayKeysRequestSchema)` to create a new message.
+ */
+export declare const SendDisplayKeysRequestSchema: GenMessage<SendDisplayKeysRequest, {
+    jsonType: SendDisplayKeysRequestJson;
+}>;
+/**
+ * DisplayKeys is a list of keys and chords.
+ *
+ * @generated from message toshi.workspace.v1.DisplayKeys
+ */
+export type DisplayKeys = Message<"toshi.workspace.v1.DisplayKeys"> & {
+    /**
+     * @generated from field: repeated string keys = 1;
+     */
+    keys: string[];
+};
+/**
+ * DisplayKeys is a list of keys and chords.
+ *
+ * @generated from message toshi.workspace.v1.DisplayKeys
+ */
+export type DisplayKeysJson = {
+    /**
+     * @generated from field: repeated string keys = 1;
+     */
+    keys?: string[];
+};
+/**
+ * Describes the message toshi.workspace.v1.DisplayKeys.
+ * Use `create(DisplayKeysSchema)` to create a new message.
+ */
+export declare const DisplayKeysSchema: GenMessage<DisplayKeys, {
+    jsonType: DisplayKeysJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.SendDisplayKeysResponse
+ */
+export type SendDisplayKeysResponse = Message<"toshi.workspace.v1.SendDisplayKeysResponse"> & {};
+/**
+ * @generated from message toshi.workspace.v1.SendDisplayKeysResponse
+ */
+export type SendDisplayKeysResponseJson = {};
+/**
+ * Describes the message toshi.workspace.v1.SendDisplayKeysResponse.
+ * Use `create(SendDisplayKeysResponseSchema)` to create a new message.
+ */
+export declare const SendDisplayKeysResponseSchema: GenMessage<SendDisplayKeysResponse, {
+    jsonType: SendDisplayKeysResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.SendDisplayPointerRequest
+ */
+export type SendDisplayPointerRequest = Message<"toshi.workspace.v1.SendDisplayPointerRequest"> & {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+    /**
+     * Pointer states sent in order, at most 256.
+     *
+     * @generated from field: repeated toshi.workspace.v1.DisplayPointerEvent events = 2;
+     */
+    events: DisplayPointerEvent[];
+};
+/**
+ * @generated from message toshi.workspace.v1.SendDisplayPointerRequest
+ */
+export type SendDisplayPointerRequestJson = {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId?: string;
+    /**
+     * Pointer states sent in order, at most 256.
+     *
+     * @generated from field: repeated toshi.workspace.v1.DisplayPointerEvent events = 2;
+     */
+    events?: DisplayPointerEventJson[];
+};
+/**
+ * Describes the message toshi.workspace.v1.SendDisplayPointerRequest.
+ * Use `create(SendDisplayPointerRequestSchema)` to create a new message.
+ */
+export declare const SendDisplayPointerRequestSchema: GenMessage<SendDisplayPointerRequest, {
+    jsonType: SendDisplayPointerRequestJson;
+}>;
+/**
+ * DisplayPointerEvent is where the pointer is and which buttons are down.
+ *
+ * @generated from message toshi.workspace.v1.DisplayPointerEvent
+ */
+export type DisplayPointerEvent = Message<"toshi.workspace.v1.DisplayPointerEvent"> & {
+    /**
+     * Pixels from the screen's left and top edges, inside the screen as
+     * TakeDisplayScreenshot sees it; a point outside fails the call with
+     * INVALID_ARGUMENT before any event is sent.
+     *
+     * @generated from field: int32 x = 1;
+     */
+    x: number;
+    /**
+     * @generated from field: int32 y = 2;
+     */
+    y: number;
+    /**
+     * The buttons held down: 1 left, 2 middle, 4 right, 8 wheel up, 16
+     * wheel down. A click is an event with the button and one without; a
+     * wheel step is an event with 8 or 16 and one without.
+     *
+     * @generated from field: uint32 buttons = 3;
+     */
+    buttons: number;
+};
+/**
+ * DisplayPointerEvent is where the pointer is and which buttons are down.
+ *
+ * @generated from message toshi.workspace.v1.DisplayPointerEvent
+ */
+export type DisplayPointerEventJson = {
+    /**
+     * Pixels from the screen's left and top edges, inside the screen as
+     * TakeDisplayScreenshot sees it; a point outside fails the call with
+     * INVALID_ARGUMENT before any event is sent.
+     *
+     * @generated from field: int32 x = 1;
+     */
+    x?: number;
+    /**
+     * @generated from field: int32 y = 2;
+     */
+    y?: number;
+    /**
+     * The buttons held down: 1 left, 2 middle, 4 right, 8 wheel up, 16
+     * wheel down. A click is an event with the button and one without; a
+     * wheel step is an event with 8 or 16 and one without.
+     *
+     * @generated from field: uint32 buttons = 3;
+     */
+    buttons?: number;
+};
+/**
+ * Describes the message toshi.workspace.v1.DisplayPointerEvent.
+ * Use `create(DisplayPointerEventSchema)` to create a new message.
+ */
+export declare const DisplayPointerEventSchema: GenMessage<DisplayPointerEvent, {
+    jsonType: DisplayPointerEventJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.SendDisplayPointerResponse
+ */
+export type SendDisplayPointerResponse = Message<"toshi.workspace.v1.SendDisplayPointerResponse"> & {};
+/**
+ * @generated from message toshi.workspace.v1.SendDisplayPointerResponse
+ */
+export type SendDisplayPointerResponseJson = {};
+/**
+ * Describes the message toshi.workspace.v1.SendDisplayPointerResponse.
+ * Use `create(SendDisplayPointerResponseSchema)` to create a new message.
+ */
+export declare const SendDisplayPointerResponseSchema: GenMessage<SendDisplayPointerResponse, {
+    jsonType: SendDisplayPointerResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.SetDisplayClipboardRequest
+ */
+export type SetDisplayClipboardRequest = Message<"toshi.workspace.v1.SetDisplayClipboardRequest"> & {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+    /**
+     * At most 256 KiB, in Latin-1 (the RFB protocol's clipboard); other
+     * text fails the call with INVALID_ARGUMENT.
+     *
+     * @generated from field: string text = 2;
+     */
+    text: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.SetDisplayClipboardRequest
+ */
+export type SetDisplayClipboardRequestJson = {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId?: string;
+    /**
+     * At most 256 KiB, in Latin-1 (the RFB protocol's clipboard); other
+     * text fails the call with INVALID_ARGUMENT.
+     *
+     * @generated from field: string text = 2;
+     */
+    text?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.SetDisplayClipboardRequest.
+ * Use `create(SetDisplayClipboardRequestSchema)` to create a new message.
+ */
+export declare const SetDisplayClipboardRequestSchema: GenMessage<SetDisplayClipboardRequest, {
+    jsonType: SetDisplayClipboardRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.SetDisplayClipboardResponse
+ */
+export type SetDisplayClipboardResponse = Message<"toshi.workspace.v1.SetDisplayClipboardResponse"> & {};
+/**
+ * @generated from message toshi.workspace.v1.SetDisplayClipboardResponse
+ */
+export type SetDisplayClipboardResponseJson = {};
+/**
+ * Describes the message toshi.workspace.v1.SetDisplayClipboardResponse.
+ * Use `create(SetDisplayClipboardResponseSchema)` to create a new message.
+ */
+export declare const SetDisplayClipboardResponseSchema: GenMessage<SetDisplayClipboardResponse, {
+    jsonType: SetDisplayClipboardResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.TakeDisplayScreenshotRequest
+ */
+export type TakeDisplayScreenshotRequest = Message<"toshi.workspace.v1.TakeDisplayScreenshotRequest"> & {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.TakeDisplayScreenshotRequest
+ */
+export type TakeDisplayScreenshotRequestJson = {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.TakeDisplayScreenshotRequest.
+ * Use `create(TakeDisplayScreenshotRequestSchema)` to create a new message.
+ */
+export declare const TakeDisplayScreenshotRequestSchema: GenMessage<TakeDisplayScreenshotRequest, {
+    jsonType: TakeDisplayScreenshotRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.TakeDisplayScreenshotResponse
+ */
+export type TakeDisplayScreenshotResponse = Message<"toshi.workspace.v1.TakeDisplayScreenshotResponse"> & {
+    /**
+     * The screen as a PNG image.
+     *
+     * @generated from field: bytes png = 1;
+     */
+    png: Uint8Array;
+    /**
+     * @generated from field: int32 width = 2;
+     */
+    width: number;
+    /**
+     * @generated from field: int32 height = 3;
+     */
+    height: number;
+    /**
+     * @generated from field: google.protobuf.Timestamp taken_at = 4;
+     */
+    takenAt?: Timestamp | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.TakeDisplayScreenshotResponse
+ */
+export type TakeDisplayScreenshotResponseJson = {
+    /**
+     * The screen as a PNG image.
+     *
+     * @generated from field: bytes png = 1;
+     */
+    png?: string;
+    /**
+     * @generated from field: int32 width = 2;
+     */
+    width?: number;
+    /**
+     * @generated from field: int32 height = 3;
+     */
+    height?: number;
+    /**
+     * @generated from field: google.protobuf.Timestamp taken_at = 4;
+     */
+    takenAt?: TimestampJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.TakeDisplayScreenshotResponse.
+ * Use `create(TakeDisplayScreenshotResponseSchema)` to create a new message.
+ */
+export declare const TakeDisplayScreenshotResponseSchema: GenMessage<TakeDisplayScreenshotResponse, {
+    jsonType: TakeDisplayScreenshotResponseJson;
+}>;
+/**
+ * DisplayMode is what a session's viewer may do.
+ *
+ * @generated from enum toshi.workspace.v1.DisplayMode
+ */
+export declare enum DisplayMode {
+    /**
+     * View only.
+     *
+     * @generated from enum value: DISPLAY_MODE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * The viewer sees the screen; the relay drops its keys, pointer and
+     * clipboard.
+     *
+     * @generated from enum value: DISPLAY_MODE_VIEW_ONLY = 1;
+     */
+    VIEW_ONLY = 1,
+    /**
+     * The viewer sees the screen and sends keys, pointer and clipboard. One
+     * open session of a job has input at a time.
+     *
+     * @generated from enum value: DISPLAY_MODE_WITH_INPUT = 2;
+     */
+    WITH_INPUT = 2
+}
+/**
+ * DisplayMode is what a session's viewer may do.
+ *
+ * @generated from enum toshi.workspace.v1.DisplayMode
+ */
+export type DisplayModeJson = "DISPLAY_MODE_UNSPECIFIED" | "DISPLAY_MODE_VIEW_ONLY" | "DISPLAY_MODE_WITH_INPUT";
+/**
+ * Describes the enum toshi.workspace.v1.DisplayMode.
+ */
+export declare const DisplayModeSchema: GenEnum<DisplayMode, DisplayModeJson>;
+/**
+ * @generated from enum toshi.workspace.v1.DisplaySessionState
+ */
+export declare enum DisplaySessionState {
+    /**
+     * @generated from enum value: DISPLAY_SESSION_STATE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Opened; its viewer has not presented the token yet.
+     *
+     * @generated from enum value: DISPLAY_SESSION_STATE_WAITING = 1;
+     */
+    WAITING = 1,
+    /**
+     * Its viewer is attached.
+     *
+     * @generated from enum value: DISPLAY_SESSION_STATE_ATTACHED = 2;
+     */
+    ATTACHED = 2,
+    /**
+     * @generated from enum value: DISPLAY_SESSION_STATE_CLOSED = 3;
+     */
+    CLOSED = 3
+}
+/**
+ * @generated from enum toshi.workspace.v1.DisplaySessionState
+ */
+export type DisplaySessionStateJson = "DISPLAY_SESSION_STATE_UNSPECIFIED" | "DISPLAY_SESSION_STATE_WAITING" | "DISPLAY_SESSION_STATE_ATTACHED" | "DISPLAY_SESSION_STATE_CLOSED";
+/**
+ * Describes the enum toshi.workspace.v1.DisplaySessionState.
+ */
+export declare const DisplaySessionStateSchema: GenEnum<DisplaySessionState, DisplaySessionStateJson>;
+/**
+ * DisplayOpener is how a session was opened.
+ *
+ * @generated from enum toshi.workspace.v1.DisplayOpener
+ */
+export declare enum DisplayOpener {
+    /**
+     * @generated from enum value: DISPLAY_OPENER_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * A person, signed in to the dashboard.
+     *
+     * @generated from enum value: DISPLAY_OPENER_PERSON = 1;
+     */
+    PERSON = 1,
+    /**
+     * A program, with an API token.
+     *
+     * @generated from enum value: DISPLAY_OPENER_PROGRAM = 2;
+     */
+    PROGRAM = 2
+}
+/**
+ * DisplayOpener is how a session was opened.
+ *
+ * @generated from enum toshi.workspace.v1.DisplayOpener
+ */
+export type DisplayOpenerJson = "DISPLAY_OPENER_UNSPECIFIED" | "DISPLAY_OPENER_PERSON" | "DISPLAY_OPENER_PROGRAM";
+/**
+ * Describes the enum toshi.workspace.v1.DisplayOpener.
+ */
+export declare const DisplayOpenerSchema: GenEnum<DisplayOpener, DisplayOpenerJson>;
+/**
+ * DisplayService opens display sessions: one viewer's live view of the
+ * screen of a VM that runs one of the workspace's CI jobs. The caller's
+ * credential names the workspace, as for WorkloadService; a session or a job
+ * of another workspace is NOT_FOUND.
+ *
+ * A session carries the screen as the RFB protocol (RFC 6143) over a
+ * WebSocket at the session's URL, the framing noVNC speaks. Its token,
+ * in the answer to OpenDisplaySession and in no other, attaches it once:
+ * the viewer presents it before the token expires, and a closed, attached
+ * or expired session refuses it.
+ *
+ * The plan sets how many sessions one job may have at once, attached or
+ * waiting for their viewer, and the longest idle close; a plan without
+ * displays refuses every open with FAILED_PRECONDITION. A suspended
+ * workspace opens none, and its open sessions close.
+ *
+ * @generated from service toshi.workspace.v1.DisplayService
+ */
+export declare const DisplayService: GenService<{
+    /**
+     * OpenDisplaySession opens a session on a running job and returns its
+     * URL and token. A job that is not running, or one beyond the plan's
+     * viewers, or a second session with input on a job, fails with
+     * FAILED_PRECONDITION. A session ends when it is closed, when no bytes
+     * of the screen's protocol go either way for its idle close, when its
+     * token expires before it attaches, when its job stops running on the
+     * VM it was opened on, or when the workspace is suspended.
+     *
+     * request_key works as WorkloadService's, except that a retry never
+     * returns the token: it returns the session the first call opened, with
+     * replayed set and no token, and opens nothing. Open another session for
+     * a new token.
+     *
+     * @generated from rpc toshi.workspace.v1.DisplayService.OpenDisplaySession
+     */
+    openDisplaySession: {
+        methodKind: "unary";
+        input: typeof OpenDisplaySessionRequestSchema;
+        output: typeof OpenDisplaySessionResponseSchema;
+    };
+    /**
+     * GetDisplaySession returns one session. An unknown ID fails with
+     * NOT_FOUND.
+     *
+     * @generated from rpc toshi.workspace.v1.DisplayService.GetDisplaySession
+     */
+    getDisplaySession: {
+        methodKind: "unary";
+        input: typeof GetDisplaySessionRequestSchema;
+        output: typeof GetDisplaySessionResponseSchema;
+    };
+    /**
+     * ListDisplaySessions returns the workspace's sessions, the newest
+     * first.
+     *
+     * A page holds 50 sessions when page_size is zero, and 200 at most.
+     *
+     * @generated from rpc toshi.workspace.v1.DisplayService.ListDisplaySessions
+     */
+    listDisplaySessions: {
+        methodKind: "unary";
+        input: typeof ListDisplaySessionsRequestSchema;
+        output: typeof ListDisplaySessionsResponseSchema;
+    };
+    /**
+     * CloseDisplaySession closes a session and ends its viewer's connection.
+     * Closing a closed session changes nothing.
+     *
+     * @generated from rpc toshi.workspace.v1.DisplayService.CloseDisplaySession
+     */
+    closeDisplaySession: {
+        methodKind: "unary";
+        input: typeof CloseDisplaySessionRequestSchema;
+        output: typeof CloseDisplaySessionResponseSchema;
+    };
+    /**
+     * SendDisplayKeys presses and releases keys on the screen. A view-only
+     * session refuses it with FAILED_PRECONDITION.
+     *
+     * @generated from rpc toshi.workspace.v1.DisplayService.SendDisplayKeys
+     */
+    sendDisplayKeys: {
+        methodKind: "unary";
+        input: typeof SendDisplayKeysRequestSchema;
+        output: typeof SendDisplayKeysResponseSchema;
+    };
+    /**
+     * SendDisplayPointer moves the pointer and presses or releases its
+     * buttons. A view-only session refuses it with FAILED_PRECONDITION.
+     *
+     * @generated from rpc toshi.workspace.v1.DisplayService.SendDisplayPointer
+     */
+    sendDisplayPointer: {
+        methodKind: "unary";
+        input: typeof SendDisplayPointerRequestSchema;
+        output: typeof SendDisplayPointerResponseSchema;
+    };
+    /**
+     * SetDisplayClipboard sets the screen's clipboard. It reaches the
+     * guest's own clipboard only where the guest image runs a clipboard
+     * agent. A view-only session refuses it with FAILED_PRECONDITION.
+     *
+     * @generated from rpc toshi.workspace.v1.DisplayService.SetDisplayClipboard
+     */
+    setDisplayClipboard: {
+        methodKind: "unary";
+        input: typeof SetDisplayClipboardRequestSchema;
+        output: typeof SetDisplayClipboardResponseSchema;
+    };
+    /**
+     * TakeDisplayScreenshot returns the whole screen as it is now, as a
+     * PNG, once every pixel of a new frame has arrived: within the call's
+     * deadline and at most 10 s, or DEADLINE_EXCEEDED. A screen larger
+     * than 3840 x 2160 fails with FAILED_PRECONDITION; the control plane's
+     * memory for frames, shared by its sessions, with RESOURCE_EXHAUSTED. A
+     * view-only session takes them too.
+     *
+     * @generated from rpc toshi.workspace.v1.DisplayService.TakeDisplayScreenshot
+     */
+    takeDisplayScreenshot: {
+        methodKind: "unary";
+        input: typeof TakeDisplayScreenshotRequestSchema;
+        output: typeof TakeDisplayScreenshotResponseSchema;
+    };
+}>;