@toshicloud/sdk 0.5.0 → 0.5.1

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

@@ -0,0 +1,1463 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { FieldMask, FieldMaskJson, Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file toshi/workspace/v1/images.proto.
+ */
+export declare const file_toshi_workspace_v1_images: GenFile;
+/**
+ * Image is a project's own image.
+ *
+ * @generated from message toshi.workspace.v1.Image
+ */
+export type Image = Message<"toshi.workspace.v1.Image"> & {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * @generated from field: string name = 2;
+     */
+    name: string;
+    /**
+     * The name of the project it belongs to.
+     *
+     * @generated from field: string project = 3;
+     */
+    project: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageKind kind = 4;
+     */
+    kind: ImageKind;
+    /**
+     * The one of Toshi's images it is built on, such as ubuntu-24.04.
+     *
+     * @generated from field: string base = 5;
+     */
+    base: string;
+    /**
+     * The size its builds run at; empty for a container image that is
+     * pushed.
+     *
+     * @generated from field: string size = 6;
+     */
+    size: string;
+    /**
+     * The recipe its next build runs, in TOML: that of its newest ready
+     * version, or the one it was created with until a build is ready.
+     *
+     * @generated from field: string recipe = 7;
+     */
+    recipe: string;
+    /**
+     * The SHA-256 of recipe, in hex.
+     *
+     * @generated from field: string recipe_digest = 8;
+     */
+    recipeDigest: string;
+    /**
+     * The environment whose secret sets its builds receive. For a container
+     * image built from a repository, the one its first build took: each
+     * build takes the one the branch rules choose then.
+     *
+     * @generated from field: string environment = 9;
+     */
+    environment: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 10;
+     */
+    createdAt?: Timestamp | undefined;
+    /**
+     * @generated from field: google.protobuf.Timestamp updated_at = 11;
+     */
+    updatedAt?: Timestamp | undefined;
+    /**
+     * Its newest ready version; unset when it has none.
+     *
+     * @generated from field: toshi.workspace.v1.ImageVersion latest = 12;
+     */
+    latest?: ImageVersion | undefined;
+    /**
+     * The repository a container image is built from, as owner/name, and
+     * the builder its builds use; empty and unspecified for one that is
+     * pushed.
+     *
+     * @generated from field: string source = 13;
+     */
+    source: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageBuilder builder = 14;
+     */
+    builder: ImageBuilder;
+    /**
+     * The reference a container image built from a repository pushes to in
+     * the workspace's own registry, and the key of the build secret that
+     * holds that registry's Docker config.json; both empty when its builds
+     * push to the deployment's registry.
+     *
+     * @generated from field: string registry = 15;
+     */
+    registry: string;
+    /**
+     * @generated from field: string registry_secret = 16;
+     */
+    registrySecret: string;
+    /**
+     * A container image built from a repository is built again on each push
+     * to its source's default branch: at most one build per push, while one
+     * runs the newest push waits and replaces an older one that waited, and
+     * a push to another branch, a fork's or one that deletes the branch
+     * builds nothing. Off unless set.
+     *
+     * @generated from field: bool rebuild_on_push = 17;
+     */
+    rebuildOnPush: boolean;
+    /**
+     * Whether recipe declares an [agent] table: a job, sandbox or service
+     * that runs the image is an agent. Set by Toshi from the recipe.
+     *
+     * @generated from field: bool agent = 18;
+     */
+    agent: boolean;
+    /**
+     * The reference a client pulls a container image by from the
+     * deployment's registry, pinned to its newest ready version, such as
+     * registry.example.com/<workspace id>/<name>@sha256:<hex>. Empty for a
+     * disk image, for one whose builds push to the workspace's own registry,
+     * for one with no ready version, and when the deployment runs no
+     * registry.
+     *
+     * @generated from field: string reference = 19;
+     */
+    reference: string;
+};
+/**
+ * Image is a project's own image.
+ *
+ * @generated from message toshi.workspace.v1.Image
+ */
+export type ImageJson = {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+    /**
+     * @generated from field: string name = 2;
+     */
+    name?: string;
+    /**
+     * The name of the project it belongs to.
+     *
+     * @generated from field: string project = 3;
+     */
+    project?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageKind kind = 4;
+     */
+    kind?: ImageKindJson;
+    /**
+     * The one of Toshi's images it is built on, such as ubuntu-24.04.
+     *
+     * @generated from field: string base = 5;
+     */
+    base?: string;
+    /**
+     * The size its builds run at; empty for a container image that is
+     * pushed.
+     *
+     * @generated from field: string size = 6;
+     */
+    size?: string;
+    /**
+     * The recipe its next build runs, in TOML: that of its newest ready
+     * version, or the one it was created with until a build is ready.
+     *
+     * @generated from field: string recipe = 7;
+     */
+    recipe?: string;
+    /**
+     * The SHA-256 of recipe, in hex.
+     *
+     * @generated from field: string recipe_digest = 8;
+     */
+    recipeDigest?: string;
+    /**
+     * The environment whose secret sets its builds receive. For a container
+     * image built from a repository, the one its first build took: each
+     * build takes the one the branch rules choose then.
+     *
+     * @generated from field: string environment = 9;
+     */
+    environment?: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 10;
+     */
+    createdAt?: TimestampJson;
+    /**
+     * @generated from field: google.protobuf.Timestamp updated_at = 11;
+     */
+    updatedAt?: TimestampJson;
+    /**
+     * Its newest ready version; unset when it has none.
+     *
+     * @generated from field: toshi.workspace.v1.ImageVersion latest = 12;
+     */
+    latest?: ImageVersionJson;
+    /**
+     * The repository a container image is built from, as owner/name, and
+     * the builder its builds use; empty and unspecified for one that is
+     * pushed.
+     *
+     * @generated from field: string source = 13;
+     */
+    source?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageBuilder builder = 14;
+     */
+    builder?: ImageBuilderJson;
+    /**
+     * The reference a container image built from a repository pushes to in
+     * the workspace's own registry, and the key of the build secret that
+     * holds that registry's Docker config.json; both empty when its builds
+     * push to the deployment's registry.
+     *
+     * @generated from field: string registry = 15;
+     */
+    registry?: string;
+    /**
+     * @generated from field: string registry_secret = 16;
+     */
+    registrySecret?: string;
+    /**
+     * A container image built from a repository is built again on each push
+     * to its source's default branch: at most one build per push, while one
+     * runs the newest push waits and replaces an older one that waited, and
+     * a push to another branch, a fork's or one that deletes the branch
+     * builds nothing. Off unless set.
+     *
+     * @generated from field: bool rebuild_on_push = 17;
+     */
+    rebuildOnPush?: boolean;
+    /**
+     * Whether recipe declares an [agent] table: a job, sandbox or service
+     * that runs the image is an agent. Set by Toshi from the recipe.
+     *
+     * @generated from field: bool agent = 18;
+     */
+    agent?: boolean;
+    /**
+     * The reference a client pulls a container image by from the
+     * deployment's registry, pinned to its newest ready version, such as
+     * registry.example.com/<workspace id>/<name>@sha256:<hex>. Empty for a
+     * disk image, for one whose builds push to the workspace's own registry,
+     * for one with no ready version, and when the deployment runs no
+     * registry.
+     *
+     * @generated from field: string reference = 19;
+     */
+    reference?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.Image.
+ * Use `create(ImageSchema)` to create a new message.
+ */
+export declare const ImageSchema: GenMessage<Image, {
+    jsonType: ImageJson;
+}>;
+/**
+ * ImageVersion is one build of an image, or one push of a container image.
+ *
+ * @generated from message toshi.workspace.v1.ImageVersion
+ */
+export type ImageVersion = Message<"toshi.workspace.v1.ImageVersion"> & {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * Counts from 1 in the order the image's versions were recorded: a
+     * build's when it started, failed ones included, and a push's when Toshi
+     * found it.
+     *
+     * @generated from field: int64 number = 2;
+     */
+    number: bigint;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageVersionState state = 3;
+     */
+    state: ImageVersionState;
+    /**
+     * The base it was built on, and that base's SHA-256 in hex; the base is
+     * kept while a version uses it.
+     *
+     * @generated from field: string base = 4;
+     */
+    base: string;
+    /**
+     * @generated from field: string base_digest = 5;
+     */
+    baseDigest: string;
+    /**
+     * The bytes its overlay holds in the object store; 0 until ready.
+     *
+     * @generated from field: int64 size_bytes = 6;
+     */
+    sizeBytes: bigint;
+    /**
+     * The SHA-256 of the recipe it was built from, in hex.
+     *
+     * @generated from field: string recipe_digest = 7;
+     */
+    recipeDigest: string;
+    /**
+     * The job that built it.
+     *
+     * @generated from field: string build_job_id = 8;
+     */
+    buildJobId: string;
+    /**
+     * Why its build failed; empty unless state is FAILED.
+     *
+     * @generated from field: string failure = 9;
+     */
+    failure: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 10;
+     */
+    createdAt?: Timestamp | undefined;
+    /**
+     * @generated from field: google.protobuf.Timestamp ready_at = 11;
+     */
+    readyAt?: Timestamp | undefined;
+    /**
+     * When it became pending deletion, and when its overlay is deleted.
+     *
+     * @generated from field: google.protobuf.Timestamp pending_since = 12;
+     */
+    pendingSince?: Timestamp | undefined;
+    /**
+     * @generated from field: google.protobuf.Timestamp delete_after = 13;
+     */
+    deleteAfter?: Timestamp | undefined;
+    /**
+     * @generated from field: google.protobuf.Timestamp deleted_at = 14;
+     */
+    deletedAt?: Timestamp | undefined;
+    /**
+     * On a version pending deletion or deleted: the service revisions made
+     * with it, which a rollback can no longer select.
+     *
+     * @generated from field: repeated toshi.workspace.v1.ImageVersionPin pinned_by = 15;
+     */
+    pinnedBy: ImageVersionPin[];
+    /**
+     * A container version's manifest digest, sha256:<hex>, once ready, and
+     * what pushed it.
+     *
+     * @generated from field: string digest = 16;
+     */
+    digest: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImagePusher pushed_by = 17;
+     */
+    pushedBy: ImagePusher;
+    /**
+     * A container version's build: the commit it built, the builder that
+     * built it (never AUTO), and for Railpack its version and the digest of
+     * its BuildKit frontend.
+     *
+     * @generated from field: string source_commit = 18;
+     */
+    sourceCommit: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageBuilder builder = 19;
+     */
+    builder: ImageBuilder;
+    /**
+     * @generated from field: string builder_version = 20;
+     */
+    builderVersion: string;
+    /**
+     * @generated from field: string builder_frontend_digest = 21;
+     */
+    builderFrontendDigest: string;
+    /**
+     * Whether the build's commit is the source repository's own rather than
+     * a fork's. An untrusted build receives no build secrets.
+     *
+     * @generated from field: bool trusted = 22;
+     */
+    trusted: boolean;
+    /**
+     * The tag a container version pushed by hand was found under; empty for
+     * a build's version. A later push of the same tag is a new version.
+     *
+     * @generated from field: string tag = 23;
+     */
+    tag: string;
+    /**
+     * Whether the recipe this version was built from declares an [agent]
+     * table. Set by Toshi from that recipe.
+     *
+     * @generated from field: bool agent = 24;
+     */
+    agent: boolean;
+};
+/**
+ * ImageVersion is one build of an image, or one push of a container image.
+ *
+ * @generated from message toshi.workspace.v1.ImageVersion
+ */
+export type ImageVersionJson = {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+    /**
+     * Counts from 1 in the order the image's versions were recorded: a
+     * build's when it started, failed ones included, and a push's when Toshi
+     * found it.
+     *
+     * @generated from field: int64 number = 2;
+     */
+    number?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageVersionState state = 3;
+     */
+    state?: ImageVersionStateJson;
+    /**
+     * The base it was built on, and that base's SHA-256 in hex; the base is
+     * kept while a version uses it.
+     *
+     * @generated from field: string base = 4;
+     */
+    base?: string;
+    /**
+     * @generated from field: string base_digest = 5;
+     */
+    baseDigest?: string;
+    /**
+     * The bytes its overlay holds in the object store; 0 until ready.
+     *
+     * @generated from field: int64 size_bytes = 6;
+     */
+    sizeBytes?: string;
+    /**
+     * The SHA-256 of the recipe it was built from, in hex.
+     *
+     * @generated from field: string recipe_digest = 7;
+     */
+    recipeDigest?: string;
+    /**
+     * The job that built it.
+     *
+     * @generated from field: string build_job_id = 8;
+     */
+    buildJobId?: string;
+    /**
+     * Why its build failed; empty unless state is FAILED.
+     *
+     * @generated from field: string failure = 9;
+     */
+    failure?: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 10;
+     */
+    createdAt?: TimestampJson;
+    /**
+     * @generated from field: google.protobuf.Timestamp ready_at = 11;
+     */
+    readyAt?: TimestampJson;
+    /**
+     * When it became pending deletion, and when its overlay is deleted.
+     *
+     * @generated from field: google.protobuf.Timestamp pending_since = 12;
+     */
+    pendingSince?: TimestampJson;
+    /**
+     * @generated from field: google.protobuf.Timestamp delete_after = 13;
+     */
+    deleteAfter?: TimestampJson;
+    /**
+     * @generated from field: google.protobuf.Timestamp deleted_at = 14;
+     */
+    deletedAt?: TimestampJson;
+    /**
+     * On a version pending deletion or deleted: the service revisions made
+     * with it, which a rollback can no longer select.
+     *
+     * @generated from field: repeated toshi.workspace.v1.ImageVersionPin pinned_by = 15;
+     */
+    pinnedBy?: ImageVersionPinJson[];
+    /**
+     * A container version's manifest digest, sha256:<hex>, once ready, and
+     * what pushed it.
+     *
+     * @generated from field: string digest = 16;
+     */
+    digest?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImagePusher pushed_by = 17;
+     */
+    pushedBy?: ImagePusherJson;
+    /**
+     * A container version's build: the commit it built, the builder that
+     * built it (never AUTO), and for Railpack its version and the digest of
+     * its BuildKit frontend.
+     *
+     * @generated from field: string source_commit = 18;
+     */
+    sourceCommit?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageBuilder builder = 19;
+     */
+    builder?: ImageBuilderJson;
+    /**
+     * @generated from field: string builder_version = 20;
+     */
+    builderVersion?: string;
+    /**
+     * @generated from field: string builder_frontend_digest = 21;
+     */
+    builderFrontendDigest?: string;
+    /**
+     * Whether the build's commit is the source repository's own rather than
+     * a fork's. An untrusted build receives no build secrets.
+     *
+     * @generated from field: bool trusted = 22;
+     */
+    trusted?: boolean;
+    /**
+     * The tag a container version pushed by hand was found under; empty for
+     * a build's version. A later push of the same tag is a new version.
+     *
+     * @generated from field: string tag = 23;
+     */
+    tag?: string;
+    /**
+     * Whether the recipe this version was built from declares an [agent]
+     * table. Set by Toshi from that recipe.
+     *
+     * @generated from field: bool agent = 24;
+     */
+    agent?: boolean;
+};
+/**
+ * Describes the message toshi.workspace.v1.ImageVersion.
+ * Use `create(ImageVersionSchema)` to create a new message.
+ */
+export declare const ImageVersionSchema: GenMessage<ImageVersion, {
+    jsonType: ImageVersionJson;
+}>;
+/**
+ * ImageVersionPin is a service revision made with an image version.
+ *
+ * @generated from message toshi.workspace.v1.ImageVersionPin
+ */
+export type ImageVersionPin = Message<"toshi.workspace.v1.ImageVersionPin"> & {
+    /**
+     * @generated from field: string service_id = 1;
+     */
+    serviceId: string;
+    /**
+     * @generated from field: string service_name = 2;
+     */
+    serviceName: string;
+    /**
+     * @generated from field: int64 revision = 3;
+     */
+    revision: bigint;
+};
+/**
+ * ImageVersionPin is a service revision made with an image version.
+ *
+ * @generated from message toshi.workspace.v1.ImageVersionPin
+ */
+export type ImageVersionPinJson = {
+    /**
+     * @generated from field: string service_id = 1;
+     */
+    serviceId?: string;
+    /**
+     * @generated from field: string service_name = 2;
+     */
+    serviceName?: string;
+    /**
+     * @generated from field: int64 revision = 3;
+     */
+    revision?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ImageVersionPin.
+ * Use `create(ImageVersionPinSchema)` to create a new message.
+ */
+export declare const ImageVersionPinSchema: GenMessage<ImageVersionPin, {
+    jsonType: ImageVersionPinJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.CreateImageRequest
+ */
+export type CreateImageRequest = Message<"toshi.workspace.v1.CreateImageRequest"> & {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project: string;
+    /**
+     * The environment whose secret sets the image's builds receive; empty is
+     * the project's default environment. Empty for a container image built
+     * from a repository.
+     *
+     * @generated from field: string environment = 2;
+     */
+    environment: string;
+    /**
+     * @generated from field: string name = 3;
+     */
+    name: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageKind kind = 4;
+     */
+    kind: ImageKind;
+    /**
+     * A disk's base, empty for a container image; the size a disk's or a
+     * container image built from a repository's builds run at.
+     *
+     * @generated from field: string base = 5;
+     */
+    base: string;
+    /**
+     * @generated from field: string size = 6;
+     */
+    size: string;
+    /**
+     * In the format of a service's recipe, in TOML. An image uses its setup
+     * hook, which is required, and its process's env and cwd for that hook;
+     * any other field fails with INVALID_ARGUMENT. Empty for a container
+     * image.
+     *
+     * @generated from field: string recipe = 7;
+     */
+    recipe: string;
+    /**
+     * The repository a container image is built from, as owner/name; empty
+     * for one that is pushed. The builder defaults to AUTO.
+     *
+     * @generated from field: string source = 8;
+     */
+    source: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageBuilder builder = 9;
+     */
+    builder: ImageBuilder;
+    /**
+     * A reference in the workspace's own registry for the builds to push to,
+     * such as ghcr.io/acme/web, and the key of a build secret granted to the
+     * image's builds that holds its Docker config.json; both empty to push
+     * to the deployment's registry.
+     *
+     * @generated from field: string registry = 10;
+     */
+    registry: string;
+    /**
+     * @generated from field: string registry_secret = 11;
+     */
+    registrySecret: string;
+    /**
+     * Builds the image again on each push to its source's default branch,
+     * as Image.rebuild_on_push says; only for one built from a repository.
+     *
+     * @generated from field: bool rebuild_on_push = 12;
+     */
+    rebuildOnPush: boolean;
+    /**
+     * @generated from field: string request_key = 13;
+     */
+    requestKey: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.CreateImageRequest
+ */
+export type CreateImageRequestJson = {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project?: string;
+    /**
+     * The environment whose secret sets the image's builds receive; empty is
+     * the project's default environment. Empty for a container image built
+     * from a repository.
+     *
+     * @generated from field: string environment = 2;
+     */
+    environment?: string;
+    /**
+     * @generated from field: string name = 3;
+     */
+    name?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageKind kind = 4;
+     */
+    kind?: ImageKindJson;
+    /**
+     * A disk's base, empty for a container image; the size a disk's or a
+     * container image built from a repository's builds run at.
+     *
+     * @generated from field: string base = 5;
+     */
+    base?: string;
+    /**
+     * @generated from field: string size = 6;
+     */
+    size?: string;
+    /**
+     * In the format of a service's recipe, in TOML. An image uses its setup
+     * hook, which is required, and its process's env and cwd for that hook;
+     * any other field fails with INVALID_ARGUMENT. Empty for a container
+     * image.
+     *
+     * @generated from field: string recipe = 7;
+     */
+    recipe?: string;
+    /**
+     * The repository a container image is built from, as owner/name; empty
+     * for one that is pushed. The builder defaults to AUTO.
+     *
+     * @generated from field: string source = 8;
+     */
+    source?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ImageBuilder builder = 9;
+     */
+    builder?: ImageBuilderJson;
+    /**
+     * A reference in the workspace's own registry for the builds to push to,
+     * such as ghcr.io/acme/web, and the key of a build secret granted to the
+     * image's builds that holds its Docker config.json; both empty to push
+     * to the deployment's registry.
+     *
+     * @generated from field: string registry = 10;
+     */
+    registry?: string;
+    /**
+     * @generated from field: string registry_secret = 11;
+     */
+    registrySecret?: string;
+    /**
+     * Builds the image again on each push to its source's default branch,
+     * as Image.rebuild_on_push says; only for one built from a repository.
+     *
+     * @generated from field: bool rebuild_on_push = 12;
+     */
+    rebuildOnPush?: boolean;
+    /**
+     * @generated from field: string request_key = 13;
+     */
+    requestKey?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.CreateImageRequest.
+ * Use `create(CreateImageRequestSchema)` to create a new message.
+ */
+export declare const CreateImageRequestSchema: GenMessage<CreateImageRequest, {
+    jsonType: CreateImageRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.CreateImageResponse
+ */
+export type CreateImageResponse = Message<"toshi.workspace.v1.CreateImageResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.Image image = 1;
+     */
+    image?: Image | undefined;
+    /**
+     * The version the image's first build makes, building.
+     *
+     * @generated from field: toshi.workspace.v1.ImageVersion version = 2;
+     */
+    version?: ImageVersion | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.CreateImageResponse
+ */
+export type CreateImageResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.Image image = 1;
+     */
+    image?: ImageJson;
+    /**
+     * The version the image's first build makes, building.
+     *
+     * @generated from field: toshi.workspace.v1.ImageVersion version = 2;
+     */
+    version?: ImageVersionJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.CreateImageResponse.
+ * Use `create(CreateImageResponseSchema)` to create a new message.
+ */
+export declare const CreateImageResponseSchema: GenMessage<CreateImageResponse, {
+    jsonType: CreateImageResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.GetImageRequest
+ */
+export type GetImageRequest = Message<"toshi.workspace.v1.GetImageRequest"> & {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project: string;
+    /**
+     * @generated from field: string name = 2;
+     */
+    name: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.GetImageRequest
+ */
+export type GetImageRequestJson = {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project?: string;
+    /**
+     * @generated from field: string name = 2;
+     */
+    name?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.GetImageRequest.
+ * Use `create(GetImageRequestSchema)` to create a new message.
+ */
+export declare const GetImageRequestSchema: GenMessage<GetImageRequest, {
+    jsonType: GetImageRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.GetImageResponse
+ */
+export type GetImageResponse = Message<"toshi.workspace.v1.GetImageResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.Image image = 1;
+     */
+    image?: Image | undefined;
+    /**
+     * Newest first.
+     *
+     * @generated from field: repeated toshi.workspace.v1.ImageVersion versions = 2;
+     */
+    versions: ImageVersion[];
+};
+/**
+ * @generated from message toshi.workspace.v1.GetImageResponse
+ */
+export type GetImageResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.Image image = 1;
+     */
+    image?: ImageJson;
+    /**
+     * Newest first.
+     *
+     * @generated from field: repeated toshi.workspace.v1.ImageVersion versions = 2;
+     */
+    versions?: ImageVersionJson[];
+};
+/**
+ * Describes the message toshi.workspace.v1.GetImageResponse.
+ * Use `create(GetImageResponseSchema)` to create a new message.
+ */
+export declare const GetImageResponseSchema: GenMessage<GetImageResponse, {
+    jsonType: GetImageResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListImagesRequest
+ */
+export type ListImagesRequest = Message<"toshi.workspace.v1.ListImagesRequest"> & {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project: string;
+    /**
+     * The most images in one page; zero lets the server choose.
+     *
+     * @generated from field: int32 page_size = 2;
+     */
+    pageSize: number;
+    /**
+     * From an earlier response's next_page_token; empty for the first page.
+     *
+     * @generated from field: string page_token = 3;
+     */
+    pageToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.ListImagesRequest
+ */
+export type ListImagesRequestJson = {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project?: string;
+    /**
+     * The most images in one page; zero lets the server choose.
+     *
+     * @generated from field: int32 page_size = 2;
+     */
+    pageSize?: number;
+    /**
+     * From an earlier response's next_page_token; empty for the first page.
+     *
+     * @generated from field: string page_token = 3;
+     */
+    pageToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ListImagesRequest.
+ * Use `create(ListImagesRequestSchema)` to create a new message.
+ */
+export declare const ListImagesRequestSchema: GenMessage<ListImagesRequest, {
+    jsonType: ListImagesRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListImagesResponse
+ */
+export type ListImagesResponse = Message<"toshi.workspace.v1.ListImagesResponse"> & {
+    /**
+     * @generated from field: repeated toshi.workspace.v1.Image images = 1;
+     */
+    images: Image[];
+    /**
+     * Empty on the last page.
+     *
+     * @generated from field: string next_page_token = 2;
+     */
+    nextPageToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.ListImagesResponse
+ */
+export type ListImagesResponseJson = {
+    /**
+     * @generated from field: repeated toshi.workspace.v1.Image images = 1;
+     */
+    images?: ImageJson[];
+    /**
+     * Empty on the last page.
+     *
+     * @generated from field: string next_page_token = 2;
+     */
+    nextPageToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ListImagesResponse.
+ * Use `create(ListImagesResponseSchema)` to create a new message.
+ */
+export declare const ListImagesResponseSchema: GenMessage<ListImagesResponse, {
+    jsonType: ListImagesResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.BuildImageRequest
+ */
+export type BuildImageRequest = Message<"toshi.workspace.v1.BuildImageRequest"> & {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project: string;
+    /**
+     * @generated from field: string name = 2;
+     */
+    name: string;
+    /**
+     * Empty: the image's recipe. Empty for a container image.
+     *
+     * @generated from field: string recipe = 3;
+     */
+    recipe: string;
+    /**
+     * A container image's Railpack builds use the Railpack version its
+     * newest ready version was built with; true builds with the one Toshi's
+     * build image holds. Unset for a disk image.
+     *
+     * @generated from field: bool update_builder = 4;
+     */
+    updateBuilder: boolean;
+};
+/**
+ * @generated from message toshi.workspace.v1.BuildImageRequest
+ */
+export type BuildImageRequestJson = {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project?: string;
+    /**
+     * @generated from field: string name = 2;
+     */
+    name?: string;
+    /**
+     * Empty: the image's recipe. Empty for a container image.
+     *
+     * @generated from field: string recipe = 3;
+     */
+    recipe?: string;
+    /**
+     * A container image's Railpack builds use the Railpack version its
+     * newest ready version was built with; true builds with the one Toshi's
+     * build image holds. Unset for a disk image.
+     *
+     * @generated from field: bool update_builder = 4;
+     */
+    updateBuilder?: boolean;
+};
+/**
+ * Describes the message toshi.workspace.v1.BuildImageRequest.
+ * Use `create(BuildImageRequestSchema)` to create a new message.
+ */
+export declare const BuildImageRequestSchema: GenMessage<BuildImageRequest, {
+    jsonType: BuildImageRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.BuildImageResponse
+ */
+export type BuildImageResponse = Message<"toshi.workspace.v1.BuildImageResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.ImageVersion version = 1;
+     */
+    version?: ImageVersion | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.BuildImageResponse
+ */
+export type BuildImageResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.ImageVersion version = 1;
+     */
+    version?: ImageVersionJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.BuildImageResponse.
+ * Use `create(BuildImageResponseSchema)` to create a new message.
+ */
+export declare const BuildImageResponseSchema: GenMessage<BuildImageResponse, {
+    jsonType: BuildImageResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.UpdateImageRequest
+ */
+export type UpdateImageRequest = Message<"toshi.workspace.v1.UpdateImageRequest"> & {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project: string;
+    /**
+     * name names the image; the fields update_mask names carry the new
+     * values.
+     *
+     * @generated from field: toshi.workspace.v1.Image image = 2;
+     */
+    image?: Image | undefined;
+    /**
+     * @generated from field: google.protobuf.FieldMask update_mask = 3;
+     */
+    updateMask?: FieldMask | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.UpdateImageRequest
+ */
+export type UpdateImageRequestJson = {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project?: string;
+    /**
+     * name names the image; the fields update_mask names carry the new
+     * values.
+     *
+     * @generated from field: toshi.workspace.v1.Image image = 2;
+     */
+    image?: ImageJson;
+    /**
+     * @generated from field: google.protobuf.FieldMask update_mask = 3;
+     */
+    updateMask?: FieldMaskJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.UpdateImageRequest.
+ * Use `create(UpdateImageRequestSchema)` to create a new message.
+ */
+export declare const UpdateImageRequestSchema: GenMessage<UpdateImageRequest, {
+    jsonType: UpdateImageRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.UpdateImageResponse
+ */
+export type UpdateImageResponse = Message<"toshi.workspace.v1.UpdateImageResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.Image image = 1;
+     */
+    image?: Image | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.UpdateImageResponse
+ */
+export type UpdateImageResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.Image image = 1;
+     */
+    image?: ImageJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.UpdateImageResponse.
+ * Use `create(UpdateImageResponseSchema)` to create a new message.
+ */
+export declare const UpdateImageResponseSchema: GenMessage<UpdateImageResponse, {
+    jsonType: UpdateImageResponseJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.DeleteImageRequest
+ */
+export type DeleteImageRequest = Message<"toshi.workspace.v1.DeleteImageRequest"> & {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project: string;
+    /**
+     * @generated from field: string name = 2;
+     */
+    name: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.DeleteImageRequest
+ */
+export type DeleteImageRequestJson = {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project?: string;
+    /**
+     * @generated from field: string name = 2;
+     */
+    name?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.DeleteImageRequest.
+ * Use `create(DeleteImageRequestSchema)` to create a new message.
+ */
+export declare const DeleteImageRequestSchema: GenMessage<DeleteImageRequest, {
+    jsonType: DeleteImageRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.DeleteImageResponse
+ */
+export type DeleteImageResponse = Message<"toshi.workspace.v1.DeleteImageResponse"> & {};
+/**
+ * @generated from message toshi.workspace.v1.DeleteImageResponse
+ */
+export type DeleteImageResponseJson = {};
+/**
+ * Describes the message toshi.workspace.v1.DeleteImageResponse.
+ * Use `create(DeleteImageResponseSchema)` to create a new message.
+ */
+export declare const DeleteImageResponseSchema: GenMessage<DeleteImageResponse, {
+    jsonType: DeleteImageResponseJson;
+}>;
+/**
+ * ImageKind is what an image is.
+ *
+ * @generated from enum toshi.workspace.v1.ImageKind
+ */
+export declare enum ImageKind {
+    /**
+     * @generated from enum value: IMAGE_KIND_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * A disk: an overlay on one of Toshi's bases, which a VM boots from.
+     *
+     * @generated from enum value: IMAGE_KIND_DISK = 1;
+     */
+    DISK = 1,
+    /**
+     * A container image, in the deployment's container registry at
+     * <workspace id>/<name>. It has no base or recipe. One with a source is
+     * built from that repository; one without is pushed and not built.
+     *
+     * @generated from enum value: IMAGE_KIND_CONTAINER = 2;
+     */
+    CONTAINER = 2
+}
+/**
+ * ImageKind is what an image is.
+ *
+ * @generated from enum toshi.workspace.v1.ImageKind
+ */
+export type ImageKindJson = "IMAGE_KIND_UNSPECIFIED" | "IMAGE_KIND_DISK" | "IMAGE_KIND_CONTAINER";
+/**
+ * Describes the enum toshi.workspace.v1.ImageKind.
+ */
+export declare const ImageKindSchema: GenEnum<ImageKind, ImageKindJson>;
+/**
+ * ImageBuilder is what builds a container image from its source.
+ *
+ * @generated from enum toshi.workspace.v1.ImageBuilder
+ */
+export declare enum ImageBuilder {
+    /**
+     * @generated from enum value: IMAGE_BUILDER_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * The repository's Dockerfile when its root has one, Railpack
+     * otherwise. A version records the one that built it.
+     *
+     * @generated from enum value: IMAGE_BUILDER_AUTO = 1;
+     */
+    AUTO = 1,
+    /**
+     * The Dockerfile at the repository's root.
+     *
+     * @generated from enum value: IMAGE_BUILDER_DOCKERFILE = 2;
+     */
+    DOCKERFILE = 2,
+    /**
+     * Railpack, which builds from the repository's source alone.
+     *
+     * @generated from enum value: IMAGE_BUILDER_RAILPACK = 3;
+     */
+    RAILPACK = 3
+}
+/**
+ * ImageBuilder is what builds a container image from its source.
+ *
+ * @generated from enum toshi.workspace.v1.ImageBuilder
+ */
+export type ImageBuilderJson = "IMAGE_BUILDER_UNSPECIFIED" | "IMAGE_BUILDER_AUTO" | "IMAGE_BUILDER_DOCKERFILE" | "IMAGE_BUILDER_RAILPACK";
+/**
+ * Describes the enum toshi.workspace.v1.ImageBuilder.
+ */
+export declare const ImageBuilderSchema: GenEnum<ImageBuilder, ImageBuilderJson>;
+/**
+ * ImagePusher is what pushed a container image's version.
+ *
+ * @generated from enum toshi.workspace.v1.ImagePusher
+ */
+export declare enum ImagePusher {
+    /**
+     * @generated from enum value: IMAGE_PUSHER_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * A build of the image.
+     *
+     * @generated from enum value: IMAGE_PUSHER_BUILD = 1;
+     */
+    BUILD = 1,
+    /**
+     * A push to the deployment's registry by a person or a pipeline, found
+     * there by Toshi within about a minute.
+     *
+     * @generated from enum value: IMAGE_PUSHER_HAND = 2;
+     */
+    HAND = 2
+}
+/**
+ * ImagePusher is what pushed a container image's version.
+ *
+ * @generated from enum toshi.workspace.v1.ImagePusher
+ */
+export type ImagePusherJson = "IMAGE_PUSHER_UNSPECIFIED" | "IMAGE_PUSHER_BUILD" | "IMAGE_PUSHER_HAND";
+/**
+ * Describes the enum toshi.workspace.v1.ImagePusher.
+ */
+export declare const ImagePusherSchema: GenEnum<ImagePusher, ImagePusherJson>;
+/**
+ * ImageVersionState is where a version is in its life.
+ *
+ * @generated from enum toshi.workspace.v1.ImageVersionState
+ */
+export declare enum ImageVersionState {
+    /**
+     * @generated from enum value: IMAGE_VERSION_STATE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Its build job runs.
+     *
+     * @generated from enum value: IMAGE_VERSION_STATE_BUILDING = 1;
+     */
+    BUILDING = 1,
+    /**
+     * Its build did not finish; nothing of it is stored and no workload
+     * starts from it. The image is unchanged.
+     *
+     * @generated from enum value: IMAGE_VERSION_STATE_FAILED = 2;
+     */
+    FAILED = 2,
+    /**
+     * Stored: a workload that names the image starts from the newest one.
+     *
+     * @generated from enum value: IMAGE_VERSION_STATE_READY = 3;
+     */
+    READY = 3,
+    /**
+     * Neither one of the newest ready versions the retention rule keeps nor
+     * in use: its overlay is deleted at delete_after.
+     *
+     * @generated from enum value: IMAGE_VERSION_STATE_PENDING_DELETION = 4;
+     */
+    PENDING_DELETION = 4,
+    /**
+     * Its overlay is deleted.
+     *
+     * @generated from enum value: IMAGE_VERSION_STATE_DELETED = 5;
+     */
+    DELETED = 5
+}
+/**
+ * ImageVersionState is where a version is in its life.
+ *
+ * @generated from enum toshi.workspace.v1.ImageVersionState
+ */
+export type ImageVersionStateJson = "IMAGE_VERSION_STATE_UNSPECIFIED" | "IMAGE_VERSION_STATE_BUILDING" | "IMAGE_VERSION_STATE_FAILED" | "IMAGE_VERSION_STATE_READY" | "IMAGE_VERSION_STATE_PENDING_DELETION" | "IMAGE_VERSION_STATE_DELETED";
+/**
+ * Describes the enum toshi.workspace.v1.ImageVersionState.
+ */
+export declare const ImageVersionStateSchema: GenEnum<ImageVersionState, ImageVersionStateJson>;
+/**
+ * ImageService keeps a project's own images. A disk image is built on one
+ * of Toshi's bases, at one size, from a recipe in the format services use:
+ * a fresh VM of the base runs the recipe's setup hook once, and the VM's
+ * disk becomes the image's next version, an overlay on that base. A
+ * workload names an image to start from its newest ready version.
+ *
+ * The caller's credential names the workspace, as for WorkloadService.
+ * Every request names a project; an empty one is the default project. A
+ * project the workspace does not have is NOT_FOUND, and so is an image of
+ * another project. With a token limited to one project, any other project
+ * is PERMISSION_DENIED, whether the workspace has it or not.
+ *
+ * An image's name is unique among the workspace's images that are not
+ * deleted, in every project, since a CI job names an image by the runner
+ * label toshi-image-<name>. A name is lower-case letters, digits and
+ * hyphens, starts and ends with a letter or a digit, and is at most 51
+ * characters, so that the label is at most 63.
+ *
+ * Versions are kept by a retention rule. An image keeps its newest ready
+ * versions, 3 unless the control plane or the workspace's plan sets
+ * another number, and any version in use: one a workload that started
+ * from it and has not ended runs on, or one a service revision a rollback
+ * may select was made with. Any other ready version is pending deletion
+ * for 7 days unless the control plane or the plan sets another time, then
+ * its overlay is deleted. A service revision whose version is
+ * pending deletion or deleted cannot be selected by a rollback.
+ *
+ * Creating an image needs a plan that allows images; a workspace whose
+ * plan does not fails with FAILED_PRECONDITION and the reason
+ * PLAN_EXCLUDES_IMAGES. CreateImage takes a request_key; the other calls
+ * take none.
+ *
+ * @generated from service toshi.workspace.v1.ImageService
+ */
+export declare const ImageService: GenService<{
+    /**
+     * CreateImage creates the image. A name another live image of the
+     * workspace has fails with ALREADY_EXISTS and the reason
+     * IMAGE_NAME_TAKEN. A base that is not one of Toshi's, a size that is
+     * not a Linux size, or a recipe without a setup hook or with a field an
+     * image does not use, fails with INVALID_ARGUMENT. A container image
+     * that is pushed takes a name and its kind alone; one with a base, size
+     * or recipe fails with INVALID_ARGUMENT.
+     *
+     * A container image built from a repository takes its source, a Linux
+     * size and, optionally, a builder and a registry to push to; one with a
+     * base, a recipe or an environment fails with INVALID_ARGUMENT, as its
+     * builds take the environment the project's branch rules choose for the
+     * source's default branch. A source the project does not claim, or that
+     * none of the workspace's GitHub connections reaches, fails with
+     * FAILED_PRECONDITION.
+     *
+     * Creating a disk image, or a container image built from a repository,
+     * starts its first build, as BuildImage does; the response's version is
+     * that build's. A workspace whose plan
+     * does not include images fails with FAILED_PRECONDITION and the reason
+     * PLAN_EXCLUDES_IMAGES.
+     *
+     * @generated from rpc toshi.workspace.v1.ImageService.CreateImage
+     */
+    createImage: {
+        methodKind: "unary";
+        input: typeof CreateImageRequestSchema;
+        output: typeof CreateImageResponseSchema;
+    };
+    /**
+     * BuildImage starts a build of the image. A disk image's build is a job
+     * that runs the recipe's setup hook in a fresh VM of the base and saves
+     * its disk as the next version; a recipe in the request is the build's,
+     * and becomes the image's when the version is ready. A container image's
+     * build is a job that builds the tip of its source's default branch in a
+     * fresh VM and pushes it; the version is ready with the pushed digest.
+     * An image with a build in progress fails with FAILED_PRECONDITION and
+     * the reason IMAGE_BUILD_IN_PROGRESS, and a container image that is
+     * pushed rather than built, with FAILED_PRECONDITION.
+     *
+     * @generated from rpc toshi.workspace.v1.ImageService.BuildImage
+     */
+    buildImage: {
+        methodKind: "unary";
+        input: typeof BuildImageRequestSchema;
+        output: typeof BuildImageResponseSchema;
+    };
+    /**
+     * UpdateImage sets the fields of the image that update_mask names; the
+     * request's image names it by its name. The one field it sets is
+     * rebuild_on_push, of a container image built from a repository: an
+     * unset update_mask sets it to the image's value, and an empty one, "*"
+     * or a path of another field is INVALID_ARGUMENT. A
+     * disk image or a container image that is pushed is FAILED_PRECONDITION.
+     * Turning rebuild_on_push on needs what BuildImage needs of the image:
+     * a source its project claims, and a call that reaches the environment
+     * the branch rules choose for the source's default branch.
+     *
+     * @generated from rpc toshi.workspace.v1.ImageService.UpdateImage
+     */
+    updateImage: {
+        methodKind: "unary";
+        input: typeof UpdateImageRequestSchema;
+        output: typeof UpdateImageResponseSchema;
+    };
+    /**
+     * GetImage returns the image with its versions, newest first.
+     *
+     * @generated from rpc toshi.workspace.v1.ImageService.GetImage
+     */
+    getImage: {
+        methodKind: "unary";
+        input: typeof GetImageRequestSchema;
+        output: typeof GetImageResponseSchema;
+    };
+    /**
+     * ListImages returns the project's images that are not deleted, ordered
+     * by name, each with its newest ready version.
+     *
+     * A page holds 100 images when page_size is zero, and 1000 at most.
+     *
+     * @generated from rpc toshi.workspace.v1.ImageService.ListImages
+     */
+    listImages: {
+        methodKind: "unary";
+        input: typeof ListImagesRequestSchema;
+        output: typeof ListImagesResponseSchema;
+    };
+    /**
+     * DeleteImage deletes the image and frees its name. Its versions are
+     * pending deletion at once, with no 7-day wait, and their overlays are
+     * deleted soon after. An image with a version in use fails with
+     * FAILED_PRECONDITION and the reason IMAGE_IN_USE, naming what uses it.
+     *
+     * @generated from rpc toshi.workspace.v1.ImageService.DeleteImage
+     */
+    deleteImage: {
+        methodKind: "unary";
+        input: typeof DeleteImageRequestSchema;
+        output: typeof DeleteImageResponseSchema;
+    };
+}>;