feat: Add more compute resource API descriptions to match with VM's machine type field (googleapis#11588)

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: ohmayr <omairnaveed@ymail.com>

Author: gcf-owl-bot[bot]

packages/google-cloud-batch/google/cloud/batch/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.16.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-batch/google/cloud/batch_v1/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.16.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-batch/google/cloud/batch_v1alpha/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.16.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-batch/google/cloud/batch_v1alpha/types/job.py

@@ -784,7 +784,10 @@ class InstancePolicy(proto.Message):
             disks (MutableSequence[google.cloud.batch_v1alpha.types.AllocationPolicy.AttachedDisk]):
                 Non-boot disks to be attached for each VM
                 created by this InstancePolicy. New disks will
-                be deleted when the VM is deleted.
+                be deleted when the VM is deleted. A non
+                bootable 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.
             reservation (str):
                 If specified, VMs will consume only the
                 specified reservation. If not specified
@@ -832,7 +835,11 @@ class InstancePolicy(proto.Message):
         )
 
     class InstancePolicyOrTemplate(proto.Message):
-        r"""Either an InstancePolicy or an instance template.
+        r"""InstancePolicyOrTemplate lets you define the type of
+        resources to use for this job either with an InstancePolicy or
+        an instance template. If undefined, Batch picks the type of VM
+        to use and doesn't include optional VM resources such as GPUs
+        and extra disks.
 
         This message has `oneof`_ fields (mutually exclusive fields).
         For each oneof, at most one member field can be set at the same time.

packages/google-cloud-batch/google/cloud/batch_v1alpha/types/task.py

@@ -41,13 +41,56 @@
 
 
 class ComputeResource(proto.Message):
-    r"""Compute resource requirements
+    r"""Compute resource requirements.
+
+    ComputeResource defines the amount of resources required for each
+    task. Make sure your tasks have enough resources to successfully
+    run. If you also define the types of resources for a job to use with
+    the
+    `InstancePolicyOrTemplate <https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate>`__
+    field, make sure both fields are compatible with each other.
 
     Attributes:
         cpu_milli (int):
             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.
         memory_mib (int):
             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.
         gpu_count (int):
             The GPU count.
             Not yet implemented.

packages/google-cloud-batch/samples/generated_samples/snippet_metadata_google.cloud.batch.v1.json

@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-batch",
-    "version": "0.16.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

packages/google-cloud-batch/samples/generated_samples/snippet_metadata_google.cloud.batch.v1alpha.json

@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-batch",
-    "version": "0.16.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {