@origincloud/pvs 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,31 @@
-# Temporary Holding Version
+# @origincloud/pvs
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The client of Origin Cloud's persistent volume service (PVS): volumes,
+snapshots and storage classes. Part of the
+[Origin Cloud SDK for TypeScript](https://github.com/origincloudhq/sdk-typescript),
+generated from the API definitions in
+[origincloudhq/api](https://github.com/origincloudhq/api).
+
+```ts
+import { Client } from "@origincloud/core";
+import { VolumeClient } from "@origincloud/pvs/v1beta1";
+
+const volumes = new VolumeClient(new Client());
+const volume = await (
+  await volumes.createVolume({
+    parent: "projects/my-project-123/zones/eu-central1-az1",
+    volume: { sizeGib: 10 },
+  })
+).wait();
+```
+
+| Import | API |
+|---|---|
+| `@origincloud/pvs/v1beta1` | Volumes, snapshots and storage classes |
+| `@origincloud/pvs/longrunning/v1beta1` | PVS operations, for resuming one by name |
+
+`v1beta1` is a preview version and may change in incompatible ways, like the
+API itself. See the [repository's README](https://github.com/origincloudhq/sdk-typescript#readme)
+for credentials and behaviour.
+
+Apache License 2.0.

package/dist/longrunning/v1beta1/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./operations.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/longrunning/v1beta1/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/longrunning/v1beta1/index.ts"],"names":[],"mappings":"AAEA,cAAc,iBAAiB,CAAC"}

package/dist/longrunning/v1beta1/index.js

@@ -0,0 +1,3 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+export * from "./operations.js";
+//# sourceMappingURL=index.js.map

package/dist/longrunning/v1beta1/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/longrunning/v1beta1/index.ts"],"names":[],"mappings":"AAAA,mEAAmE;AAEnE,cAAc,iBAAiB,CAAC"}

package/dist/longrunning/v1beta1/operations.d.ts

@@ -0,0 +1,63 @@
+import { type CallOptions, type Client, type LongrunningOperation, type Service } from "@origincloud/core";
+/**
+ * Calls OperationService.
+ *
+ * The long-running operations of a service: what its creates, updates and
+ * deletes answer with, until their resource settles. Every service serves
+ * this at its own host, for the operations its own methods return.
+ *
+ * An operation is done when its resource reaches the state its method
+ * promises, or failed when it can't get there; that outcome never changes
+ * afterwards, whatever later happens to the resource. It can be read for a
+ * day after it is done.
+ */
+export declare class OperationClient {
+    /**
+     * The endpoint the client sends its calls to, which also serves the
+     * operations its methods answer with.
+     */
+    readonly service: Service;
+    /**
+     * A client of OperationService at the pvs host, which serves the
+     * operations the pvs methods answer with.
+     */
+    constructor(client: Client);
+    /** Returns an operation as it is now. */
+    getOperation(request: GetOperationRequest, options?: CallOptions): Promise<LongrunningOperation>;
+    /**
+     * Waits until an operation is done or `timeout` has passed, whichever
+     * comes first, and returns it as it is then. It only reads, so a client
+     * may repeat it after a transport error.
+     */
+    waitOperation(request: WaitOperationRequest, options?: CallOptions): Promise<LongrunningOperation>;
+}
+/** The request for GetOperation. */
+export interface GetOperationRequest {
+    /**
+     * The operation to return, `projects/{project}/zones/{zone}/operations/{operation}`,
+     * exactly as a method returned it.
+     */
+    name?: string;
+}
+/** The request for WaitOperation. */
+export interface WaitOperationRequest {
+    /** The operation to wait for, exactly as a method returned it. */
+    name?: string;
+    /** The longest to wait, at most a minute; a minute when not set. */
+    timeout?: string;
+}
+/** What an operation is about. */
+export interface OperationMetadata {
+    /** The resource the operation acts on. */
+    target?: string;
+    /**
+     * What it does, as the method that started it names it: for example
+     * `create`, `update` or `delete`.
+     */
+    verb?: string;
+    /** When it was accepted. */
+    createTime?: string;
+    /** When it finished; empty while it hasn't. */
+    endTime?: string;
+}
+//# sourceMappingURL=operations.d.ts.map

package/dist/longrunning/v1beta1/operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../../../src/longrunning/v1beta1/operations.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,OAAO,EAGb,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;;;;;GAWG;AACH,qBAAa,eAAe;IAC1B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;OAGG;gBACS,MAAM,EAAE,MAAM;IAI1B,yCAAyC;IACnC,YAAY,CAAC,OAAO,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAatG;;;;OAIG;IACG,aAAa,CAAC,OAAO,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAYzG;AAED,oCAAoC;AACpC,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,qCAAqC;AACrC,MAAM,WAAW,oBAAoB;IACnC,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,kCAAkC;AAClC,MAAM,WAAW,iBAAiB;IAChC,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/longrunning/v1beta1/operations.js

@@ -0,0 +1,54 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/longrunning/v1beta1/operations.proto
+import { pathValue, query, } from "@origincloud/core";
+/**
+ * Calls OperationService.
+ *
+ * The long-running operations of a service: what its creates, updates and
+ * deletes answer with, until their resource settles. Every service serves
+ * this at its own host, for the operations its own methods return.
+ *
+ * An operation is done when its resource reaches the state its method
+ * promises, or failed when it can't get there; that outcome never changes
+ * afterwards, whatever later happens to the resource. It can be read for a
+ * day after it is done.
+ */
+export class OperationClient {
+    /**
+     * The endpoint the client sends its calls to, which also serves the
+     * operations its methods answer with.
+     */
+    service;
+    /**
+     * A client of OperationService at the pvs host, which serves the
+     * operations the pvs methods answer with.
+     */
+    constructor(client) {
+        this.service = client.service("pvs", true);
+    }
+    /** Returns an operation as it is now. */
+    async getOperation(request, options) {
+        const p0 = pathValue("name", request.name, "projects/*/zones/*/operations/*");
+        return this.service.call({
+            method: "GET",
+            path: `/v1beta1/${p0}`,
+            query: query(request, ["name"]),
+            idempotent: true,
+        }, options);
+    }
+    /**
+     * Waits until an operation is done or `timeout` has passed, whichever
+     * comes first, and returns it as it is then. It only reads, so a client
+     * may repeat it after a transport error.
+     */
+    async waitOperation(request, options) {
+        const p0 = pathValue("name", request.name, "projects/*/zones/*/operations/*");
+        return this.service.call({
+            method: "POST",
+            path: `/v1beta1/${p0}:wait`,
+            body: request,
+            idempotent: true,
+        }, options);
+    }
+}
+//# sourceMappingURL=operations.js.map

package/dist/longrunning/v1beta1/operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../../src/longrunning/v1beta1/operations.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,2DAA2D;AAE3D,OAAO,EAKL,SAAS,EACT,KAAK,GACN,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,eAAe;IAC1B;;;OAGG;IACM,OAAO,CAAU;IAE1B;;;OAGG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,yCAAyC;IACzC,KAAK,CAAC,YAAY,CAAC,OAA4B,EAAE,OAAqB;QACpE,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAAC;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,EAAE,EAAE;YACtB,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;YAC/B,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,OAA6B,EAAE,OAAqB;QACtE,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAAC;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,YAAY,EAAE,OAAO;YAC3B,IAAI,EAAE,OAAO;YACb,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}

package/dist/v1beta1/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./snapshot.js";
+export * from "./storage_class.js";
+export * from "./volume.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/v1beta1/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/v1beta1/index.ts"],"names":[],"mappings":"AAEA,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC"}

package/dist/v1beta1/index.js

@@ -0,0 +1,5 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+export * from "./snapshot.js";
+export * from "./storage_class.js";
+export * from "./volume.js";
+//# sourceMappingURL=index.js.map

package/dist/v1beta1/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/v1beta1/index.ts"],"names":[],"mappings":"AAAA,mEAAmE;AAEnE,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC"}

package/dist/v1beta1/snapshot.d.ts

@@ -0,0 +1,222 @@
+import { type CallOptions, type Client, type Empty, Operation, type Service } from "@origincloud/core";
+import type { OperationMetadata } from "../longrunning/v1beta1/operations.js";
+/**
+ * Calls SnapshotService.
+ *
+ * Snapshots: point-in-time copies of a volume, in the volume's zone. A
+ * protected, completed snapshot is the source of new volumes and images.
+ */
+export declare class SnapshotClient {
+    /**
+     * The endpoint the client sends its calls to, which also serves the
+     * operations its methods answer with.
+     */
+    readonly service: Service;
+    /** A client of SnapshotService that sends its calls through `client`. */
+    constructor(client: Client);
+    /** Returns a snapshot. */
+    getSnapshot(request: GetSnapshotRequest, options?: CallOptions): Promise<Snapshot>;
+    /**
+     * Lists the snapshots in a zone, oldest first. Deleted snapshots aren't
+     * listed. For every zone's snapshots, list the zones whose `services` name
+     * `pvs` with the location service (`location.origincloudapis.eu`), then
+     * each zone's snapshots.
+     */
+    listSnapshots(request: ListSnapshotsRequest, options?: CallOptions): Promise<ListSnapshotsResponse>;
+    /**
+     * Iterates over everything listSnapshots 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.
+     */
+    allSnapshots(request: ListSnapshotsRequest, options?: CallOptions): AsyncGenerator<Snapshot, void, undefined>;
+    /**
+     * Takes a snapshot of a volume. The operation is done once the copy is
+     * `COMPLETED`, or failed once it is `ERROR`.
+     *
+     * It answers with an operation to wait on, whose result is the Snapshot.
+     */
+    createSnapshot(request: CreateSnapshotRequest, options?: CallOptions): Promise<Operation<Snapshot, OperationMetadata>>;
+    /** Changes a snapshot's tags. */
+    updateSnapshot(request: UpdateSnapshotRequest, options?: CallOptions): Promise<Snapshot>;
+    /**
+     * Deletes a snapshot. It must be `COMPLETED` or `ERROR`, and unprotected.
+     * The operation is done once the snapshot is `DELETED`.
+     *
+     * It answers with an operation to wait on, which has no result.
+     */
+    deleteSnapshot(request: DeleteSnapshotRequest, options?: CallOptions): Promise<Operation<Empty, OperationMetadata>>;
+    /**
+     * Protects a snapshot, so it can be the source of volumes and images and
+     * can't be deleted. The operation is done once it is `PROTECTED`.
+     *
+     * It answers with an operation to wait on, whose result is the Snapshot.
+     */
+    protectSnapshot(request: ProtectSnapshotRequest, options?: CallOptions): Promise<Operation<Snapshot, OperationMetadata>>;
+    /**
+     * Unprotects a snapshot, so it can be deleted. Refused with
+     * `FAILED_PRECONDITION` while an image is built from it or a volume not
+     * `DELETED` was created from it; delete those first. The operation is
+     * done once it is `UNPROTECTED`.
+     *
+     * It answers with an operation to wait on, whose result is the Snapshot.
+     */
+    unprotectSnapshot(request: UnprotectSnapshotRequest, options?: CallOptions): Promise<Operation<Snapshot, OperationMetadata>>;
+}
+/** A point-in-time copy of a volume. */
+export interface Snapshot {
+    /** The snapshot's resource name. */
+    name?: string;
+    /**
+     * The snapshot's URN, the identifier access policies and the audit log
+     * use.
+     */
+    urn?: string;
+    /** The volume copied, in the same project and zone. */
+    sourceVolume?: string;
+    /**
+     * The source volume's size in GiB when it was copied: the least a volume
+     * created from the snapshot holds.
+     */
+    sourceSizeGib?: number;
+    /** Where the copy is. */
+    state?: Snapshot_State;
+    /** Why the snapshot is in `ERROR`; empty otherwise. */
+    stateReason?: string;
+    /** Whether it is protected. */
+    protectionState?: Snapshot_ProtectionState;
+    /**
+     * Why the last protection change failed, when `protectionState` is
+     * `PROTECTION_FAILED`.
+     */
+    protectionReason?: string;
+    /**
+     * The principal that took the snapshot, 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 copy is. */
+export declare const Snapshot_State: {
+    /** Not set. */
+    readonly STATE_UNSPECIFIED: "STATE_UNSPECIFIED";
+    /** Being copied. */
+    readonly PENDING: "PENDING";
+    /** Copied. */
+    readonly COMPLETED: "COMPLETED";
+    /** Being deleted. */
+    readonly DELETING: "DELETING";
+    /** Deleted. Readable by name for a day, never listed. */
+    readonly DELETED: "DELETED";
+    /**
+     * The copy or its removal failed; `stateReason` says which. There is
+     * no usable copy behind it: delete it.
+     */
+    readonly ERROR: "ERROR";
+};
+/** Where the copy is. */
+export type Snapshot_State = (typeof Snapshot_State)[keyof typeof Snapshot_State];
+/** Whether the snapshot is protected, independently of `state`. */
+export declare const Snapshot_ProtectionState: {
+    /** Not set. */
+    readonly PROTECTION_STATE_UNSPECIFIED: "PROTECTION_STATE_UNSPECIFIED";
+    /** Not protected: it can be deleted, and is no source. */
+    readonly UNPROTECTED: "UNPROTECTED";
+    /** Becoming protected. */
+    readonly PROTECTING: "PROTECTING";
+    /** Protected: a source of volumes and images, and can't be deleted. */
+    readonly PROTECTED: "PROTECTED";
+    /** Becoming unprotected. */
+    readonly UNPROTECTING: "UNPROTECTING";
+    /**
+     * The last change couldn't be applied; `protectionReason` says why.
+     * Protect or unprotect it again.
+     */
+    readonly PROTECTION_FAILED: "PROTECTION_FAILED";
+};
+/** Whether the snapshot is protected, independently of `state`. */
+export type Snapshot_ProtectionState = (typeof Snapshot_ProtectionState)[keyof typeof Snapshot_ProtectionState];
+/** The request for GetSnapshot. */
+export interface GetSnapshotRequest {
+    /** The snapshot to return. */
+    name?: string;
+}
+/** The request for ListSnapshots. */
+export interface ListSnapshotsRequest {
+    /** The zone whose snapshots to list, `projects/{project}/zones/{zone}`. */
+    parent?: string;
+    /**
+     * The most snapshots 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 ListSnapshots. */
+export interface ListSnapshotsResponse {
+    /** The snapshots on this page. */
+    snapshots?: Snapshot[];
+    /** The token for the next page; empty on the last one. */
+    nextPageToken?: string;
+}
+/** The request for CreateSnapshot. */
+export interface CreateSnapshotRequest {
+    /** The zone of the volume to copy, `projects/{project}/zones/{zone}`. */
+    parent?: string;
+    /** The snapshot to take: its source volume, and optionally its tags. */
+    snapshot?: Snapshot;
+    /**
+     * A UUID; a repeat with the same id returns the first request's
+     * operation instead of taking a second snapshot.
+     */
+    requestId?: string;
+}
+/** The request for UpdateSnapshot. */
+export interface UpdateSnapshotRequest {
+    /** The snapshot, by its name, with the tags to set. */
+    snapshot?: Snapshot;
+    /**
+     * The fields to change: `tags`, the only field that changes. `*` is the
+     * same.
+     */
+    updateMask?: string;
+}
+/** The request for DeleteSnapshot. */
+export interface DeleteSnapshotRequest {
+    /** The snapshot to delete. */
+    name?: string;
+    /**
+     * A UUID; a repeat with the same id returns the first request's
+     * operation.
+     */
+    requestId?: string;
+}
+/** The request for ProtectSnapshot. */
+export interface ProtectSnapshotRequest {
+    /** The snapshot to protect; it must be `COMPLETED`. */
+    name?: string;
+    /**
+     * A UUID; a repeat with the same id returns the first request's
+     * operation.
+     */
+    requestId?: string;
+}
+/** The request for UnprotectSnapshot. */
+export interface UnprotectSnapshotRequest {
+    /**
+     * The snapshot to unprotect; it must be `COMPLETED`, or `ERROR` so that
+     * it can then be deleted.
+     */
+    name?: string;
+    /**
+     * A UUID; a repeat with the same id returns the first request's
+     * operation.
+     */
+    requestId?: string;
+}
+//# sourceMappingURL=snapshot.d.ts.map

package/dist/v1beta1/snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.d.ts","sourceRoot":"","sources":["../../src/v1beta1/snapshot.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,KAAK,KAAK,EAEV,SAAS,EACT,KAAK,OAAO,EAIb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAE9E;;;;;GAKG;AACH,qBAAa,cAAc;IACzB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,yEAAyE;gBAC7D,MAAM,EAAE,MAAM;IAI1B,0BAA0B;IACpB,WAAW,CAAC,OAAO,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAaxF;;;;;OAKG;IACG,aAAa,CAAC,OAAO,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAazG;;;;OAIG;IACI,YAAY,CAAC,OAAO,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,CAAC;IASpH;;;;;OAKG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IAgB5H,iCAAiC;IAC3B,cAAc,CAAC,OAAO,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAa9F;;;;;OAKG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;IAezH;;;;;OAKG;IACG,eAAe,CAAC,OAAO,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IAe9H;;;;;;;OAOG;IACG,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;CAcnI;AAED,wCAAwC;AACxC,MAAM,WAAW,QAAQ;IACvB,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,yBAAyB;IACzB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+BAA+B;IAC/B,eAAe,CAAC,EAAE,wBAAwB,CAAC;IAC3C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED,yBAAyB;AACzB,eAAO,MAAM,cAAc;IACzB,eAAe;;IAEf,oBAAoB;;IAEpB,cAAc;;IAEd,qBAAqB;;IAErB,yDAAyD;;IAEzD;;;OAGG;;CAEK,CAAC;AAEX,yBAAyB;AACzB,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAElF,mEAAmE;AACnE,eAAO,MAAM,wBAAwB;IACnC,eAAe;;IAEf,0DAA0D;;IAE1D,0BAA0B;;IAE1B,uEAAuE;;IAEvE,4BAA4B;;IAE5B;;;OAGG;;CAEK,CAAC;AAEX,mEAAmE;AACnE,MAAM,MAAM,wBAAwB,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,OAAO,wBAAwB,CAAC,CAAC;AAEhH,mCAAmC;AACnC,MAAM,WAAW,kBAAkB;IACjC,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,qCAAqC;AACrC,MAAM,WAAW,oBAAoB;IACnC,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,sCAAsC;AACtC,MAAM,WAAW,qBAAqB;IACpC,kCAAkC;IAClC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,0DAA0D;IAC1D,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,sCAAsC;AACtC,MAAM,WAAW,qBAAqB;IACpC,yEAAyE;IACzE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,sCAAsC;AACtC,MAAM,WAAW,qBAAqB;IACpC,uDAAuD;IACvD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,sCAAsC;AACtC,MAAM,WAAW,qBAAqB;IACpC,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,uCAAuC;AACvC,MAAM,WAAW,sBAAsB;IACrC,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yCAAyC;AACzC,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}