@maxim_mazurok/gapi.client.batch-v1 0.0.20230721 → 0.0.20230804

package/index.d.ts

@@ -9,7 +9,7 @@
 // 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
 // Generated from: https://batch.googleapis.com/$discovery/rest?version=v1
-// Revision: 20230721
+// Revision: 20230804
 
 /// <reference types="gapi.client" />
 
@@ -284,10 +284,23 @@ declare namespace gapi.client {
             /** Extra boot disk size in MiB for each task. */
             bootDiskMib?:
                 string;
-            /** The milliCPU count. */
+            /**
+             * The milliCPU count. `cpuMilli` defines the amount of CPU resources per task in milliCPU units. For example, `1000` corresponds to 1 vCPU per task. If undefined, the default value is
+             * `2000`. If you also define the VM's machine type using the `machineType` in
+             * [InstancePolicy](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) field or inside the `instanceTemplate` in the
+             * [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure the CPU resources for both fields
+             * are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the `n2-standard-2` machine type, which
+             * has 2 vCPUs each, you are recommended to set `cpuMilli` no more than `2000`, or you are recommended to run two tasks on the same VM if you set `cpuMilli` to `1000` or less.
+             */
             cpuMilli?:
                 string;
-            /** Memory in MiB. */
+            /**
+             * Memory in MiB. `memoryMib` defines the amount of memory per task in MiB units. If undefined, the default value is `2000`. If you also define the VM's machine type using the
+             * `machineType` in [InstancePolicy](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) field or inside the `instanceTemplate` in the
+             * [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure the memory resources for both
+             * fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the `n2-standard-2` machine type,
+             * which has 8 GiB each, you are recommended to set `memoryMib` to no more than `8192`, or you are recommended to run two tasks on the same VM if you set `memoryMib` to `4096` or less.
+             */
             memoryMib?:
                 string;
         }
@@ -328,10 +341,10 @@ declare namespace gapi.client {
             diskInterface?:
                 string;
             /**
-             * Name of an image used as the data source. For example, the following are all valid URLs: * Specify the image by its family name: projects/project/global/images/family/image_family *
-             * Specify the image version: projects/project/global/images/image_version You can also use Batch customized image in short names. The following image values are supported for a boot
-             * disk: * `batch-debian`: use Batch Debian images. * `batch-centos`: use Batch CentOS images. * `batch-cos`: use Batch Container-Optimized images. * `batch-hpc-centos`: use Batch HPC
-             * CentOS images.
+             * URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name:
+             * projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short
+             * names. The following image values are supported for a boot disk: * `batch-debian`: use Batch Debian images. * `batch-centos`: use Batch CentOS images. * `batch-cos`: use Batch
+             * Container-Optimized images. * `batch-hpc-centos`: use Batch HPC CentOS images.
              */
             image?:
                 string;
@@ -378,7 +391,10 @@ declare namespace gapi.client {
             /** Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image. */
             bootDisk?:
                 Disk;
-            /** Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. */
+            /**
+             * Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a
+             * file system or a raw storage drive that is not ready for data storage and accessing.
+             */
             disks?:
                 AttachedDisk[];
             /** The Compute Engine machine type. */
@@ -596,8 +612,8 @@ declare namespace gapi.client {
         }
         interface NetworkInterface {
             /**
-             * The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs:
-             * https://www.googleapis.com/compute/v1/projects/project/global/networks/network projects/project/global/networks/network global/networks/network
+             * The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: *
+             * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
              */
             network?:
                 string;
@@ -609,9 +625,9 @@ declare namespace gapi.client {
             noExternalIpAddress?:
                 boolean;
             /**
-             * The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
-             * https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork projects/project/regions/region/subnetworks/subnetwork
-             * regions/region/subnetworks/subnetwork
+             * The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: *
+             * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} *
+             * regions/{region}/subnetworks/{subnetwork}
              */
             subnetwork?:
                 string;
@@ -649,9 +665,9 @@ declare namespace gapi.client {
             name?:
                 string;
             /**
-             * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
-             * original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
-             * original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+             * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original
+             * method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original
+             * method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
              */
             response?:
                 { [P in string]: any };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.batch-v1",
-  "version": "0.0.20230721",
+  "version": "0.0.20230804",
   "description": "TypeScript typings for Batch API v1",
   "license": "MIT",
   "author": {
@@ -15,6 +15,6 @@
   "types": "index.d.ts",
   "dependencies": {
     "@types/gapi.client": "*",
-    "@types/gapi.client.discovery": "*"
+    "@types/gapi.client.discovery-v1": "*"
   }
 }

package/tests.ts

@@ -3,7 +3,7 @@
 // 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: 20230721
+// Revision: 20230804
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */