@origincloud/resourcemanager 0.0.0-stage → 0.3.0

package/src/v1beta1/project.ts

@@ -0,0 +1,265 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/resourcemanager/v1beta1/project.proto
+
+import {
+  type CallOptions,
+  type Client,
+  type Empty,
+  type Service,
+  newRequestId,
+  pathValue,
+  query,
+} from "@origincloud/core";
+import type { ProjectQuota } from "./quota.js";
+
+/**
+ * Calls ProjectService.
+ *
+ * Projects: the namespace every resource is created in. A project belongs to
+ * one organization, and every resource name of the other APIs starts with
+ * it, `projects/{project}/...`.
+ */
+export class ProjectClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of ProjectService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("resourcemanager", false);
+  }
+
+  /** Returns a project. */
+  async getProject(request: GetProjectRequest, options?: CallOptions): Promise<Project> {
+    const p0 = pathValue("name", request.name, "projects/*");
+    return this.service.call<Project>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /** Lists an organization's projects, oldest first. */
+  async listProjects(request: ListProjectsRequest, options?: CallOptions): Promise<ListProjectsResponse> {
+    return this.service.call<ListProjectsResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/projects`,
+        query: query(request, []),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Iterates over everything listProjects 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 *allProjects(request: ListProjectsRequest, options?: CallOptions): AsyncGenerator<Project, void, undefined> {
+    for (let page = request; ; ) {
+      const response = await this.listProjects(page, options);
+      yield* response.projects ?? [];
+      if (!response.nextPageToken) return;
+      page = { ...page, pageToken: response.nextPageToken };
+    }
+  }
+
+  /**
+   * Creates a project in an `ACTIVE` organization, under the id the caller
+   * chooses. The caller becomes the project's owner, and the project is
+   * billed to the organization's default billing account. An id in use, or
+   * used by a project that was deleted, is refused as a `CONFLICT`.
+   */
+  async createProject(request: CreateProjectRequest, options?: CallOptions): Promise<Project> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    return this.service.call<Project>(
+      {
+        method: "POST",
+        path: `/v1beta1/projects`,
+        body: request.project,
+        query: query(request, ["project"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /** Renames a project. */
+  async updateProject(request: UpdateProjectRequest, options?: CallOptions): Promise<Project> {
+    const p0 = pathValue("project.name", request.project?.name, "projects/*");
+    return this.service.call<Project>(
+      {
+        method: "PATCH",
+        path: `/v1beta1/${p0}`,
+        body: request.project,
+        query: query(request, ["project.name", "project"]),
+      },
+      options,
+    );
+  }
+
+  /**
+   * Deletes a project. Refused as a `CONFLICT` while the project
+   * still has a resource you can delete yourself: an instance that isn't terminated, an image, a key
+   * pair, a volume or snapshot that isn't deleted, a NAT gateway, a floating
+   * IP, a VPC, or a DNS policy other than its default one. The refusal names
+   * every kind left, in the order to delete them. Nothing you can delete
+   * yourself is deleted on your behalf. The project's default DNS policy,
+   * its quota and every role granted on it go with it; roles granted on the
+   * organization stay.
+   */
+  async deleteProject(request: DeleteProjectRequest, options?: CallOptions): Promise<Empty> {
+    const p0 = pathValue("name", request.name, "projects/*");
+    return this.service.call<Empty>(
+      {
+        method: "DELETE",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+      },
+      options,
+    );
+  }
+
+  /**
+   * Returns a project's quota: the budget of each kind of resource the
+   * project may hold, if one is set, and how much of it the project uses.
+   */
+  async getProjectQuota(request: GetProjectQuotaRequest, options?: CallOptions): Promise<ProjectQuota> {
+    const p0 = pathValue("name", request.name, "projects/*/quota");
+    return this.service.call<ProjectQuota>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Sets or removes a project's budgets. A budget named in `updateMask`
+   * is set to the value given, or removed when the value is left out.
+   */
+  async updateProjectQuota(request: UpdateProjectQuotaRequest, options?: CallOptions): Promise<ProjectQuota> {
+    const p0 = pathValue("projectQuota.name", request.projectQuota?.name, "projects/*/quota");
+    return this.service.call<ProjectQuota>(
+      {
+        method: "PATCH",
+        path: `/v1beta1/${p0}`,
+        body: request.projectQuota,
+        query: query(request, ["projectQuota.name", "projectQuota"]),
+      },
+      options,
+    );
+  }
+}
+
+/** A project: the namespace an organization's resources are created in. */
+export interface Project {
+  /**
+   * The project's resource name, `projects/{project}`. The id, chosen when
+   * the project is created, is unique across the platform and never used
+   * again, not even after the project is deleted.
+   */
+  name?: string;
+  /**
+   * The project's URN, the identifier access policies and the audit log
+   * use.
+   */
+  urn?: string;
+  /** The organization the project belongs to, `organizations/{organization}`. */
+  organization?: string;
+  /** The name the console shows. Not empty. */
+  displayName?: string;
+  /** When the project was created. */
+  createTime?: string;
+  /**
+   * The principal that created the project, such as `user:<id>` or
+   * `service_account:<id>`.
+   */
+  creator?: string;
+}
+
+/** The request for GetProject. */
+export interface GetProjectRequest {
+  /** The project to return. */
+  name?: string;
+}
+
+/** The request for ListProjects. */
+export interface ListProjectsRequest {
+  /** The organization whose projects to list, `organizations/{organization}`. */
+  organization?: string;
+  /**
+   * The most projects 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 ListProjects. */
+export interface ListProjectsResponse {
+  /** The projects on this page. */
+  projects?: Project[];
+  /** The token for the next page; empty on the last one. */
+  nextPageToken?: string;
+}
+
+/** The request for CreateProject. */
+export interface CreateProjectRequest {
+  /** The project to create: its `organization` and `displayName`. */
+  project?: Project;
+  /**
+   * The project's id, the last segment of its name: 6 to 16 lowercase
+   * letters, digits and hyphens, starting with a letter and not ending with
+   * a hyphen, such as `acme-prod`.
+   */
+  projectId?: string;
+  /**
+   * A UUID; a repeat with the same id returns the project the first request
+   * created instead of creating a second one.
+   */
+  requestId?: string;
+}
+
+/** The request for UpdateProject. */
+export interface UpdateProjectRequest {
+  /** The project, by its name, with the fields to change. */
+  project?: Project;
+  /** The fields to change: `displayName`. `*` is the same. */
+  updateMask?: string;
+}
+
+/** The request for DeleteProject. */
+export interface DeleteProjectRequest {
+  /** The project to delete. */
+  name?: string;
+}
+
+/** The request for GetProjectQuota. */
+export interface GetProjectQuotaRequest {
+  /** The quota to return, `projects/{project}/quota`. */
+  name?: string;
+}
+
+/** The request for UpdateProjectQuota. */
+export interface UpdateProjectQuotaRequest {
+  /** The quota, by its name, with the budgets to set. */
+  projectQuota?: ProjectQuota;
+  /**
+   * The budgets to set or remove, such as `maxVcpu`. `*` is every budget:
+   * those given are set, the others removed.
+   */
+  updateMask?: string;
+}

package/src/v1beta1/quota.ts

@@ -0,0 +1,73 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/resourcemanager/v1beta1/quota.proto
+
+/**
+ * An organization's quota: the most of each kind of resource its projects
+ * may hold together, and how much of it they use. Creating a resource past a
+ * limit is refused.
+ */
+export interface OrganizationQuota {
+  /** The quota's resource name, `organizations/{organization}/quota`. */
+  name?: string;
+  /** The most instances that aren't terminated. */
+  maxInstances?: string;
+  /** The most vCPUs, summed over the instances that aren't terminated. */
+  maxVcpu?: string;
+  /** The most GiB of volumes that aren't deleted. */
+  maxVolumeGib?: string;
+  /** The most VPCs. */
+  maxVpcs?: string;
+  /** The most floating IPs. */
+  maxPublicIps?: string;
+  /** How much of each limit the organization's projects use together. */
+  usage?: QuotaUsage;
+}
+
+/**
+ * A project's quota: the budgets its owners set for it, and how much of each
+ * the project uses. A project without a budget for a kind of resource is
+ * bounded by its organization's quota alone; with one, by both. Budgets are
+ * not reservations: several projects' budgets may add up to more than the
+ * organization's limit.
+ */
+export interface ProjectQuota {
+  /** The quota's resource name, `projects/{project}/quota`. */
+  name?: string;
+  /**
+   * The most instances that aren't terminated; unset means no budget. Each
+   * budget is zero or more, and no more than the organization's limit for
+   * the same kind.
+   */
+  maxInstances?: string;
+  /**
+   * The most vCPUs, summed over the instances that aren't terminated; unset
+   * means no budget.
+   */
+  maxVcpu?: string;
+  /** The most GiB of volumes that aren't deleted; unset means no budget. */
+  maxVolumeGib?: string;
+  /** The most VPCs; unset means no budget. */
+  maxVpcs?: string;
+  /** The most floating IPs; unset means no budget. */
+  maxPublicIps?: string;
+  /** How much of each budget the project uses. */
+  usage?: QuotaUsage;
+}
+
+/**
+ * How many of each kind of resource are held. Counted continuously, so a
+ * resource just created or deleted can take up to half a minute to show;
+ * a limit is enforced on the exact count.
+ */
+export interface QuotaUsage {
+  /** Instances that aren't terminated. */
+  instances?: string;
+  /** vCPUs of the instances that aren't terminated. */
+  vcpu?: string;
+  /** GiB of volumes that aren't deleted. */
+  volumeGib?: string;
+  /** VPCs. */
+  vpcs?: string;
+  /** Floating IPs. */
+  publicIps?: string;
+}