@origincloud/pvs 0.0.0-stage → 0.2.0

package/src/v1beta1/storage_class.ts

@@ -0,0 +1,115 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/pvs/v1beta1/storage_class.proto
+
+import { type CallOptions, type Client, type Service, pathValue, query } from "@origincloud/core";
+
+/**
+ * Calls StorageClassService.
+ *
+ * The catalog of storage classes: every tier the platform publishes, each
+ * saying whether it can be selected right now. Not scoped to an
+ * organisation or a project; no permission is needed.
+ */
+export class StorageClassClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of StorageClassService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("pvs", true);
+  }
+
+  /** Returns a storage class. */
+  async getStorageClass(request: GetStorageClassRequest, options?: CallOptions): Promise<StorageClass> {
+    const p0 = pathValue("name", request.name, "storageClasses/*");
+    return this.service.call<StorageClass>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Lists every storage class, including those not yet on sale: check
+   * `available` before selecting one.
+   */
+  async listStorageClasses(request: ListStorageClassesRequest, options?: CallOptions): Promise<ListStorageClassesResponse> {
+    return this.service.call<ListStorageClassesResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/storageClasses`,
+        query: query(request, []),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+}
+
+/** A storage tier a volume is created in. */
+export interface StorageClass {
+  /** The class's resource name, `storageClasses/gp1`. */
+  name?: string;
+  /** The name the console shows. */
+  displayName?: string;
+  /** The media the class is backed by. */
+  media?: StorageClass_Media;
+  /**
+   * Whether a volume created without a storage class is created in this
+   * one.
+   */
+  defaultClass?: boolean;
+  /**
+   * Whether the class can be selected right now. A class that is listed
+   * but not available is a published tier not yet on sale.
+   */
+  available?: boolean;
+  /**
+   * The I/O operations per second a volume of the class is limited to; 0
+   * for a class not on sale.
+   */
+  baselineIops?: number;
+  /**
+   * The MiB per second a volume of the class is limited to; 0 for a class
+   * not on sale.
+   */
+  baselineThroughputMibps?: number;
+}
+
+/** The media a class is backed by. */
+export const StorageClass_Media = {
+  /** Not set. */
+  MEDIA_UNSPECIFIED: "MEDIA_UNSPECIFIED",
+  /** Solid-state storage. */
+  SSD: "SSD",
+  /** Rotational (hard-disk) storage. */
+  HDD: "HDD",
+} as const;
+
+/** The media a class is backed by. */
+export type StorageClass_Media = (typeof StorageClass_Media)[keyof typeof StorageClass_Media];
+
+/** The request for GetStorageClass. */
+export interface GetStorageClassRequest {
+  /** The class to return, `storageClasses/{storage_class}`. */
+  name?: string;
+}
+
+/**
+ * The request for ListStorageClasses. The catalog is small and bounded by
+ * the platform, so it comes in one page.
+ */
+export interface ListStorageClassesRequest {}
+
+/** The response for ListStorageClasses. */
+export interface ListStorageClassesResponse {
+  /** Every storage class, in catalog order. */
+  storageClasses?: StorageClass[];
+}

package/src/v1beta1/volume.ts

@@ -0,0 +1,366 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/pvs/v1beta1/volume.proto
+
+import {
+  type CallOptions,
+  type Client,
+  type Empty,
+  type LongrunningOperation,
+  Operation,
+  type Service,
+  newRequestId,
+  pathValue,
+  query,
+} from "@origincloud/core";
+import type { OperationMetadata } from "../longrunning/v1beta1/operations.js";
+
+/**
+ * Calls VolumeService.
+ *
+ * Block storage volumes: durable disks in one zone that an instance attaches
+ * to read and write.
+ */
+export class VolumeClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of VolumeService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("pvs", true);
+  }
+
+  /** Returns a volume. */
+  async getVolume(request: GetVolumeRequest, options?: CallOptions): Promise<Volume> {
+    const p0 = pathValue("name", request.name, "projects/*/zones/*/volumes/*");
+    return this.service.call<Volume>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Lists the volumes in a zone, oldest first. Deleted volumes aren't
+   * listed. For every zone's volumes, list the zones whose `services` name
+   * `pvs` with the location service (`location.origincloudapis.eu`), then
+   * each zone's volumes.
+   */
+  async listVolumes(request: ListVolumesRequest, options?: CallOptions): Promise<ListVolumesResponse> {
+    const p0 = pathValue("parent", request.parent, "projects/*/zones/*");
+    return this.service.call<ListVolumesResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}/volumes`,
+        query: query(request, ["parent"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Iterates over everything listVolumes 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 *allVolumes(request: ListVolumesRequest, options?: CallOptions): AsyncGenerator<Volume, void, undefined> {
+    for (let page = request; ; ) {
+      const response = await this.listVolumes(page, options);
+      yield* response.volumes ?? [];
+      if (!response.nextPageToken) return;
+      page = { ...page, pageToken: response.nextPageToken };
+    }
+  }
+
+  /**
+   * Creates a volume, empty or as a copy of a snapshot. The operation is
+   * done once the volume is `AVAILABLE`, or failed once it is `ERROR`.
+   *
+   * It answers with an operation to wait on, whose result is the Volume.
+   */
+  async createVolume(request: CreateVolumeRequest, options?: CallOptions): Promise<Operation<Volume, OperationMetadata>> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("parent", request.parent, "projects/*/zones/*");
+    const op = await this.service.call<LongrunningOperation>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}/volumes`,
+        body: request.volume,
+        query: query(request, ["parent", "volume"]),
+        idempotent: true,
+      },
+      options,
+    );
+    return new Operation<Volume, OperationMetadata>(this.service, op, "origincloud.pvs.v1beta1.Volume");
+  }
+
+  /**
+   * Creates a volume whose initial content is a disk image the platform
+   * downloads. The operation is done once the volume is `AVAILABLE`.
+   *
+   * It answers with an operation to wait on, whose result is the Volume.
+   */
+  async importVolume(request: ImportVolumeRequest, options?: CallOptions): Promise<Operation<Volume, OperationMetadata>> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("parent", request.parent, "projects/*/zones/*");
+    const op = await this.service.call<LongrunningOperation>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}/volumes:import`,
+        body: request,
+        idempotent: true,
+      },
+      options,
+    );
+    return new Operation<Volume, OperationMetadata>(this.service, op, "origincloud.pvs.v1beta1.Volume");
+  }
+
+  /**
+   * Changes a volume's size or tags. A larger `sizeGib` grows the volume,
+   * attached or not; it never shrinks, and the size it already has changes
+   * nothing. The operation is done once the volume reports the new size.
+   *
+   * It answers with an operation to wait on, whose result is the Volume.
+   */
+  async updateVolume(request: UpdateVolumeRequest, options?: CallOptions): Promise<Operation<Volume, OperationMetadata>> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("volume.name", request.volume?.name, "projects/*/zones/*/volumes/*");
+    const op = await this.service.call<LongrunningOperation>(
+      {
+        method: "PATCH",
+        path: `/v1beta1/${p0}`,
+        body: request.volume,
+        query: query(request, ["volume.name", "volume"]),
+        idempotent: true,
+      },
+      options,
+    );
+    return new Operation<Volume, OperationMetadata>(this.service, op, "origincloud.pvs.v1beta1.Volume");
+  }
+
+  /**
+   * Deletes a volume. It must not be attached, and none of its snapshots
+   * may be left. The operation is done once the volume is `DELETED`.
+   *
+   * It answers with an operation to wait on, which has no result.
+   */
+  async deleteVolume(request: DeleteVolumeRequest, options?: CallOptions): Promise<Operation<Empty, OperationMetadata>> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("name", request.name, "projects/*/zones/*/volumes/*");
+    const op = await this.service.call<LongrunningOperation>(
+      {
+        method: "DELETE",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+    return new Operation<Empty, OperationMetadata>(this.service, op, "google.protobuf.Empty");
+  }
+}
+
+/** A block storage volume in one zone. */
+export interface Volume {
+  /** The volume's resource name. */
+  name?: string;
+  /**
+   * The volume's URN, the identifier access policies and the audit log
+   * use.
+   */
+  urn?: string;
+  /**
+   * The size in GiB, at least 1. Growing it resizes the volume; it never
+   * shrinks.
+   */
+  sizeGib?: number;
+  /**
+   * The storage class, `storageClasses/{storage_class}`. The default class
+   * when left empty.
+   */
+  storageClass?: string;
+  /**
+   * The snapshot the volume was created from, in the same project and
+   * zone; empty for an empty volume. The volume is at least the snapshot's
+   * size.
+   */
+  sourceSnapshot?: string;
+  /** Where the volume is in its lifecycle. */
+  state?: Volume_State;
+  /** Why the volume is in `ERROR`; empty otherwise. */
+  stateReason?: string;
+  /** When `state` is `IN_USE`, the id of the volume attachment holding it. */
+  attachment?: string;
+  /** Where the last resize is. */
+  resizeState?: Volume_ResizeState;
+  /** Why the last resize failed, when `resizeState` is `RESIZE_FAILED`. */
+  resizeReason?: string;
+  /**
+   * The size a resize under way is heading for; 0 when none is.
+   * `sizeGib` changes once the resize is confirmed.
+   */
+  pendingSizeGib?: number;
+  /**
+   * Why the volume is still here after the instance it was created with
+   * was terminated; empty in every other case. Most often a snapshot of it
+   * exists, and a snapshot depends on its volume's data.
+   */
+  retentionNote?: string;
+  /**
+   * The most I/O operations per second the volume serves, reads and writes
+   * combined: a ceiling, not a guaranteed rate. 0 when it isn't limited.
+   */
+  iops?: number;
+  /**
+   * The most MiB per second the volume transfers, reads and writes
+   * combined: a ceiling, not a guaranteed rate. 0 when it isn't limited.
+   */
+  throughputMibps?: number;
+  /**
+   * The principal that created the volume, such as `user:<id>` or
+   * `service_account:<id>`.
+   */
+  creator?: string;
+  /**
+   * Labels of your own, at most 50. The `origin:name` tag is the name the
+   * console shows.
+   */
+  tags?: Record<string, string>;
+}
+
+/** Where the volume is in its lifecycle. */
+export const Volume_State = {
+  /** Not set. */
+  STATE_UNSPECIFIED: "STATE_UNSPECIFIED",
+  /** Being created. */
+  CREATING: "CREATING",
+  /** Ready to attach. */
+  AVAILABLE: "AVAILABLE",
+  /** Attached to an instance. */
+  IN_USE: "IN_USE",
+  /** Being deleted. */
+  DELETING: "DELETING",
+  /** Deleted. Readable by name for a day, never listed. */
+  DELETED: "DELETED",
+  /**
+   * Its storage couldn't be created or removed; `stateReason` says
+   * which. It can be deleted again.
+   */
+  ERROR: "ERROR",
+} as const;
+
+/** Where the volume is in its lifecycle. */
+export type Volume_State = (typeof Volume_State)[keyof typeof Volume_State];
+
+/** Where a resize is. */
+export const Volume_ResizeState = {
+  /** Not set. */
+  RESIZE_STATE_UNSPECIFIED: "RESIZE_STATE_UNSPECIFIED",
+  /** No resize is under way; the last one, if any, finished. */
+  RESIZE_COMPLETED: "RESIZE_COMPLETED",
+  /** Growing to `pendingSizeGib`. */
+  RESIZING: "RESIZING",
+  /**
+   * The last resize failed; `resizeReason` says why. The volume and its
+   * data are unaffected.
+   */
+  RESIZE_FAILED: "RESIZE_FAILED",
+} as const;
+
+/** Where a resize is. */
+export type Volume_ResizeState = (typeof Volume_ResizeState)[keyof typeof Volume_ResizeState];
+
+/** The request for GetVolume. */
+export interface GetVolumeRequest {
+  /** The volume to return. */
+  name?: string;
+}
+
+/** The request for ListVolumes. */
+export interface ListVolumesRequest {
+  /** The zone whose volumes to list, `projects/{project}/zones/{zone}`. */
+  parent?: string;
+  /**
+   * The most volumes 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 ListVolumes. */
+export interface ListVolumesResponse {
+  /** The volumes on this page. */
+  volumes?: Volume[];
+  /** The token for the next page; empty on the last one. */
+  nextPageToken?: string;
+}
+
+/** The request for CreateVolume. */
+export interface CreateVolumeRequest {
+  /** The zone to create the volume in, `projects/{project}/zones/{zone}`. */
+  parent?: string;
+  /**
+   * The volume to create: its size, and optionally its storage class,
+   * source snapshot and tags.
+   */
+  volume?: Volume;
+  /**
+   * A UUID; a repeat with the same id returns the first request's
+   * operation instead of creating a second volume.
+   */
+  requestId?: string;
+}
+
+/** The request for ImportVolume. */
+export interface ImportVolumeRequest {
+  /** The zone to create the volume in, `projects/{project}/zones/{zone}`. */
+  parent?: string;
+  /**
+   * The volume to create: its size, which must hold the image, and
+   * optionally its storage class and tags.
+   */
+  volume?: Volume;
+  /**
+   * The URL of the disk image, which the platform downloads over HTTP or
+   * HTTPS: it must be reachable from the platform.
+   */
+  sourceUrl?: string;
+  /**
+   * A UUID; a repeat with the same id returns the first request's
+   * operation instead of importing twice.
+   */
+  requestId?: string;
+}
+
+/** The request for UpdateVolume. */
+export interface UpdateVolumeRequest {
+  /** The volume, by its name, with the fields to change. */
+  volume?: Volume;
+  /** The fields to change: `sizeGib`, `tags`, or both. `*` is both. */
+  updateMask?: string;
+  /**
+   * A UUID; a repeat with the same id returns the first request's
+   * operation instead of changing the volume again.
+   */
+  requestId?: string;
+}
+
+/** The request for DeleteVolume. */
+export interface DeleteVolumeRequest {
+  /** The volume to delete. */
+  name?: string;
+  /**
+   * A UUID; a repeat with the same id returns the first request's
+   * operation.
+   */
+  requestId?: string;
+}