@origincloud/compute 0.0.0-stage → 0.3.0

package/src/v1beta1/image.ts

@@ -0,0 +1,269 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/compute/v1beta1/image.proto
+
+import {
+  type CallOptions,
+  type Client,
+  type Empty,
+  type Service,
+  newRequestId,
+  pathValue,
+  query,
+} from "@origincloud/core";
+
+/**
+ * Calls ImageService.
+ *
+ * Images: what an instance's boot volume is created from, in one zone. A
+ * project creates its own from protected snapshots in the zone; the
+ * platform's public images are in `PublicImageService`.
+ */
+export class ImageClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of ImageService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("compute", true);
+  }
+
+  /** Returns one of the project's own images. */
+  async getImage(request: GetImageRequest, options?: CallOptions): Promise<Image> {
+    const p0 = pathValue("name", request.name, "projects/*/zones/*/images/*");
+    return this.service.call<Image>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Lists the project's own images in a zone, oldest first. The public
+   * images are listed by `ListPublicImages`.
+   */
+  async listImages(request: ListImagesRequest, options?: CallOptions): Promise<ListImagesResponse> {
+    const p0 = pathValue("parent", request.parent, "projects/*/zones/*");
+    return this.service.call<ListImagesResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}/images`,
+        query: query(request, ["parent"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Iterates over everything listImages lists from the request's page on,
+   * fetching the next page as the loop reaches it. A page that fails ends
+   * the iteration with its error.
+   */
+  async *allImages(request: ListImagesRequest, options?: CallOptions): AsyncGenerator<Image, void, undefined> {
+    for (let page = request; ; ) {
+      const response = await this.listImages(page, options);
+      yield* response.images ?? [];
+      if (!response.nextPageToken) return;
+      page = { ...page, pageToken: response.nextPageToken };
+    }
+  }
+
+  /**
+   * Creates an image from the project's protected snapshots in the zone.
+   * The snapshots can't be unprotected while the image exists.
+   */
+  async createImage(request: CreateImageRequest, options?: CallOptions): Promise<Image> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("parent", request.parent, "projects/*/zones/*");
+    return this.service.call<Image>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}/images`,
+        body: request.image,
+        query: query(request, ["parent", "image"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /** Changes an image's description or tags. */
+  async updateImage(request: UpdateImageRequest, options?: CallOptions): Promise<Image> {
+    const p0 = pathValue("image.name", request.image?.name, "projects/*/zones/*/images/*");
+    return this.service.call<Image>(
+      {
+        method: "PATCH",
+        path: `/v1beta1/${p0}`,
+        body: request.image,
+        query: query(request, ["image.name", "image"]),
+      },
+      options,
+    );
+  }
+
+  /** Deletes an image. Instances launched from it are unaffected. */
+  async deleteImage(request: DeleteImageRequest, options?: CallOptions): Promise<Empty> {
+    const p0 = pathValue("name", request.name, "projects/*/zones/*/images/*");
+    return this.service.call<Empty>(
+      {
+        method: "DELETE",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+      },
+      options,
+    );
+  }
+}
+
+/**
+ * A project's own image, which an instance's boot volume can be created
+ * from.
+ */
+export interface Image {
+  /** The image's resource name. */
+  name?: string;
+  /** The image's URN, the identifier access policies and the audit log use. */
+  urn?: string;
+  /** What the image holds, as you describe it. */
+  description?: string;
+  /**
+   * The account an instance launched from the image logs in as, unless the
+   * launch names another: a POSIX user name of at most 32 lowercase
+   * letters, digits, underscores and hyphens, starting with a letter or an
+   * underscore, and not `root`. `cloud` when left empty.
+   */
+  defaultUser?: string;
+  /**
+   * The device name of the disk the image boots from: one of the
+   * `blockDevices`' `device`.
+   */
+  rootDevice?: string;
+  /** The image's disks, each created for an instance launched from it. */
+  blockDevices?: ImageBlockDevice[];
+  /** The CPU architecture it boots on. */
+  architecture?: Image_Architecture;
+  /** Its operating system family. */
+  platform?: Image_Platform;
+  /** Where it is in its lifecycle. */
+  state?: Image_State;
+  /** The principal that created the image, such as `user:<id>`. */
+  creator?: string;
+  /**
+   * Labels of your own, at most 50. The `origin:name` tag is the name the
+   * console shows.
+   */
+  tags?: Record<string, string>;
+}
+
+/** The CPU architecture an image boots on. */
+export const Image_Architecture = {
+  /** Not set. */
+  ARCHITECTURE_UNSPECIFIED: "ARCHITECTURE_UNSPECIFIED",
+  /** 64-bit x86. */
+  X86_64: "X86_64",
+} as const;
+
+/** The CPU architecture an image boots on. */
+export type Image_Architecture = (typeof Image_Architecture)[keyof typeof Image_Architecture];
+
+/** The operating system family of an image. */
+export const Image_Platform = {
+  /** Not set. */
+  PLATFORM_UNSPECIFIED: "PLATFORM_UNSPECIFIED",
+  /** Linux or another Unix. */
+  LINUX_UNIX: "LINUX_UNIX",
+} as const;
+
+/** The operating system family of an image. */
+export type Image_Platform = (typeof Image_Platform)[keyof typeof Image_Platform];
+
+/** Where the image is in its lifecycle. */
+export const Image_State = {
+  /** Not set. */
+  STATE_UNSPECIFIED: "STATE_UNSPECIFIED",
+  /** Instances can be launched from it. */
+  AVAILABLE: "AVAILABLE",
+} as const;
+
+/** Where the image is in its lifecycle. */
+export type Image_State = (typeof Image_State)[keyof typeof Image_State];
+
+/** A disk of an image. */
+export interface ImageBlockDevice {
+  /**
+   * The device name the disk appears under on every instance launched from
+   * the image: `vda` to `vdz` but `vdc`, unique within the image.
+   */
+  device?: string;
+  /** The disk's size in GiB, at least the snapshot's. */
+  sizeGib?: number;
+  /**
+   * The protected snapshot the disk is created from, in the image's
+   * project and zone; an empty disk when left empty.
+   */
+  sourceSnapshot?: string;
+}
+
+/** The request for GetImage. */
+export interface GetImageRequest {
+  /** The image to return. */
+  name?: string;
+}
+
+/** The request for ListImages. */
+export interface ListImagesRequest {
+  /** The zone whose images to list, `projects/{project}/zones/{zone}`. */
+  parent?: string;
+  /**
+   * The most images to return; the server clamps it, and 0 means its
+   * default.
+   */
+  pageSize?: number;
+  /** A previous response's `nextPageToken`, for the page after it. */
+  pageToken?: string;
+}
+
+/** The response for ListImages. */
+export interface ListImagesResponse {
+  /** The images on this page. */
+  images?: Image[];
+  /** The token for the next page; empty on the last one. */
+  nextPageToken?: string;
+}
+
+/** The request for CreateImage. */
+export interface CreateImageRequest {
+  /** The zone to create the image in, `projects/{project}/zones/{zone}`. */
+  parent?: string;
+  /**
+   * The image to create: its description, root device and disks, and
+   * optionally its default user and tags.
+   */
+  image?: Image;
+  /**
+   * A UUID; a repeat with the same id returns the first request's image
+   * instead of creating a second one.
+   */
+  requestId?: string;
+}
+
+/** The request for UpdateImage. */
+export interface UpdateImageRequest {
+  /** The image, by its name, with the fields to change. */
+  image?: Image;
+  /** The fields to change: `description`, `tags`, or both. `*` is both. */
+  updateMask?: string;
+}
+
+/** The request for DeleteImage. */
+export interface DeleteImageRequest {
+  /** The image to delete. */
+  name?: string;
+}

package/src/v1beta1/index.ts

@@ -0,0 +1,8 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+
+export * from "./catalog.js";
+export * from "./image.js";
+export * from "./instance.js";
+export * from "./key_pair.js";
+export * from "./public_image.js";
+export * from "./volume_attachment.js";