@maxim_mazurok/gapi.client.tpu-v2 0.0.20221130

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.tpu-v2",
+  "version": "0.0.20221130",
+  "description": "TypeScript typings for Cloud TPU API v2",
+  "license": "MIT",
+  "author": {
+    "email": "maxim@mazurok.com",
+    "name": "Maxim Mazurok",
+    "url": "https://maxim.mazurok.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "types": "index.d.ts",
+  "dependencies": {
+    "@types/gapi.client": "*",
+    "@types/gapi.client.discovery": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,68 @@
+# TypeScript typings for Cloud TPU API v2
+
+TPU API provides customers with access to Google TPU technology.
+For detailed description please check [documentation](https://cloud.google.com/tpu/).
+
+## Installing
+
+Install typings for Cloud TPU API:
+
+```
+npm install @types/gapi.client.tpu-v2 --save-dev
+```
+
+## Usage
+
+You need to initialize Google API client in your code:
+
+```typescript
+gapi.load('client', () => {
+  // now we can use gapi.client
+  // ...
+});
+```
+
+Then load api client wrapper:
+
+```typescript
+gapi.client.load('https://tpu.googleapis.com/$discovery/rest?version=v2', () => {
+  // now we can use:
+  // gapi.client.tpu
+});
+```
+
+```typescript
+// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
+gapi.client.load('tpu', 'v2', () => {
+  // now we can use:
+  // gapi.client.tpu
+});
+```
+
+Don't forget to authenticate your client before sending any request to resources:
+
+```typescript
+// declare client_id registered in Google Developers Console
+var client_id = '',
+  scope = [
+      // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
+      'https://www.googleapis.com/auth/cloud-platform',
+    ],
+    immediate = true;
+// ...
+
+gapi.auth.authorize(
+  { client_id: client_id, scope: scope, immediate: immediate },
+  authResult => {
+    if (authResult && !authResult.error) {
+        /* handle successful authorization */
+    } else {
+        /* handle authorization error */
+    }
+});
+```
+
+After that you can use Cloud TPU API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+```

package/tests.ts

@@ -0,0 +1,274 @@
+/* This is stub file for gapi.client.tpu-v2 definition tests */
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+
+// Revision: 20221130
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://tpu.googleapis.com/$discovery/rest?version=v2');
+    /** now we can use gapi.client.tpu */
+
+    /** don't forget to authenticate your client before sending any request to resources: */
+    /** declare client_id registered in Google Developers Console */
+    const client_id = '<<PUT YOUR CLIENT ID HERE>>';
+    const scope = [
+        /** See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. */
+        'https://www.googleapis.com/auth/cloud-platform',
+    ];
+    const immediate = false;
+    gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
+        if (authResult && !authResult.error) {
+            /** handle successful authorization */
+            run();
+        } else {
+            /** handle authorization error */
+        }
+    });
+
+    async function run() {
+        /** Generates the Cloud TPU service identity for the project. */
+        await gapi.client.tpu.projects.locations.generateServiceIdentity({
+            parent: "Test string",
+        }, {
+        });
+        /** Gets information about a location. */
+        await gapi.client.tpu.projects.locations.get({
+            name: "Test string",
+        });
+        /** Lists information about the supported locations for this service. */
+        await gapi.client.tpu.projects.locations.list({
+            filter: "Test string",
+            name: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+        });
+        /** Gets AcceleratorType. */
+        await gapi.client.tpu.projects.locations.acceleratorTypes.get({
+            name: "Test string",
+        });
+        /** Lists accelerator types supported by this API. */
+        await gapi.client.tpu.projects.locations.acceleratorTypes.list({
+            filter: "Test string",
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Creates a node. */
+        await gapi.client.tpu.projects.locations.nodes.create({
+            nodeId: "Test string",
+            parent: "Test string",
+        }, {
+            acceleratorType: "Test string",
+            apiVersion: "Test string",
+            cidrBlock: "Test string",
+            createTime: "Test string",
+            dataDisks: [
+                {
+                    mode: "Test string",
+                    sourceDisk: "Test string",
+                }
+            ],
+            description: "Test string",
+            health: "Test string",
+            healthDescription: "Test string",
+            id: "Test string",
+            labels: {
+                A: "Test string"
+            },
+            metadata: {
+                A: "Test string"
+            },
+            name: "Test string",
+            networkConfig: {
+                canIpForward: true,
+                enableExternalIps: true,
+                network: "Test string",
+                subnetwork: "Test string",
+            },
+            networkEndpoints: [
+                {
+                    accessConfig: {
+                        externalIp: "Test string",
+                    },
+                    ipAddress: "Test string",
+                    port: 42,
+                }
+            ],
+            runtimeVersion: "Test string",
+            schedulingConfig: {
+                preemptible: true,
+                reserved: true,
+            },
+            serviceAccount: {
+                email: "Test string",
+                scope: [
+                    "Test string"
+                ],
+            },
+            shieldedInstanceConfig: {
+                enableSecureBoot: true,
+            },
+            state: "Test string",
+            symptoms: [
+                {
+                    createTime: "Test string",
+                    details: "Test string",
+                    symptomType: "Test string",
+                    workerId: "Test string",
+                }
+            ],
+            tags: [
+                "Test string"
+            ],
+        });
+        /** Deletes a node. */
+        await gapi.client.tpu.projects.locations.nodes.delete({
+            name: "Test string",
+        });
+        /** Gets the details of a node. */
+        await gapi.client.tpu.projects.locations.nodes.get({
+            name: "Test string",
+        });
+        /** Retrieves the guest attributes for the node. */
+        await gapi.client.tpu.projects.locations.nodes.getGuestAttributes({
+            name: "Test string",
+        }, {
+            queryPath: "Test string",
+            workerIds: [
+                "Test string"
+            ],
+        });
+        /** Lists nodes. */
+        await gapi.client.tpu.projects.locations.nodes.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Updates the configurations of a node. */
+        await gapi.client.tpu.projects.locations.nodes.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            acceleratorType: "Test string",
+            apiVersion: "Test string",
+            cidrBlock: "Test string",
+            createTime: "Test string",
+            dataDisks: [
+                {
+                    mode: "Test string",
+                    sourceDisk: "Test string",
+                }
+            ],
+            description: "Test string",
+            health: "Test string",
+            healthDescription: "Test string",
+            id: "Test string",
+            labels: {
+                A: "Test string"
+            },
+            metadata: {
+                A: "Test string"
+            },
+            name: "Test string",
+            networkConfig: {
+                canIpForward: true,
+                enableExternalIps: true,
+                network: "Test string",
+                subnetwork: "Test string",
+            },
+            networkEndpoints: [
+                {
+                    accessConfig: {
+                        externalIp: "Test string",
+                    },
+                    ipAddress: "Test string",
+                    port: 42,
+                }
+            ],
+            runtimeVersion: "Test string",
+            schedulingConfig: {
+                preemptible: true,
+                reserved: true,
+            },
+            serviceAccount: {
+                email: "Test string",
+                scope: [
+                    "Test string"
+                ],
+            },
+            shieldedInstanceConfig: {
+                enableSecureBoot: true,
+            },
+            state: "Test string",
+            symptoms: [
+                {
+                    createTime: "Test string",
+                    details: "Test string",
+                    symptomType: "Test string",
+                    workerId: "Test string",
+                }
+            ],
+            tags: [
+                "Test string"
+            ],
+        });
+        /** Starts a node. */
+        await gapi.client.tpu.projects.locations.nodes.start({
+            name: "Test string",
+        }, {
+        });
+        /** Stops a node. This operation is only available with single TPU nodes. */
+        await gapi.client.tpu.projects.locations.nodes.stop({
+            name: "Test string",
+        }, {
+        });
+        /**
+         * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this
+         * method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation
+         * completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of
+         * 1, corresponding to `Code.CANCELLED`.
+         */
+        await gapi.client.tpu.projects.locations.operations.cancel({
+            name: "Test string",
+        });
+        /**
+         * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support
+         * this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+         */
+        await gapi.client.tpu.projects.locations.operations.delete({
+            name: "Test string",
+        });
+        /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
+        await gapi.client.tpu.projects.locations.operations.get({
+            name: "Test string",
+        });
+        /**
+         * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to
+         * override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
+         * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
+         * ensure the name binding is the parent resource, without the operations collection id.
+         */
+        await gapi.client.tpu.projects.locations.operations.list({
+            filter: "Test string",
+            name: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+        });
+        /** Gets a runtime version. */
+        await gapi.client.tpu.projects.locations.runtimeVersions.get({
+            name: "Test string",
+        });
+        /** Lists runtime versions supported by this API. */
+        await gapi.client.tpu.projects.locations.runtimeVersions.list({
+            filter: "Test string",
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+    }
+});

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6", "dom"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+        "strictFunctionTypes": true
+    },
+    "files": ["index.d.ts", "tests.ts"]
+}

package/tslint.json

@@ -0,0 +1,6 @@
+{
+    "extends": "dtslint/dtslint.json",
+    "rules": {
+        "no-redundant-jsdoc": false
+    }
+}