google-cloud-batch-v1 0.10.3 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 905a90b116a0303c0b8d7ab68d20032190586563b99b96e2b4697ff60dcc1efd
-  data.tar.gz: 54691337972204cb9595844d5d8ef273ed6d8ff5e857dadcd05c70bf0622e812
+  metadata.gz: 28504849c9d52fa1ed0b1fcaeef52731f8ab705ff703a58246a2ff5458550022
+  data.tar.gz: b212d6a39424a03a9a75de9644da71e084b037a9879fa44a137e5794b14a39a3
 SHA512:
-  metadata.gz: 7db854c451e48f5a98247b643dbe202ba4d774d5da9b2900881dc659d6564d90f97fef454132f01eba171562e20a8d605deb1785b7c3c49c713a7de6432a46c9
-  data.tar.gz: 5eda9fcaec35084b418ba644881a48f5921c924d16ab12d3526b8919d8a47cd97a665a423df5f4c1a662d0e808ab9249e0f6077afc2bd2864868b6524f7bd365
+  metadata.gz: 363f72f3eaa421e2eac6fea7f15ffcd9b7a87528e908fda269ffed8773bbf58eacfa9e9e98e0b2d8bc6190383795bb1526ff187c0ab5457095ac76b4ff7d02b6
+  data.tar.gz: eb0b158af3306b399bcfd30b2f94b7e5852bdceca7d1d0b675c9291d715dad13ce1643bd7f081a6ba81957cc291346e8bd602c0d706eb30cfa10716a4535354f

data/lib/google/cloud/batch/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Batch
       module V1
-        VERSION = "0.10.3"
+        VERSION = "0.10.5"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb

@@ -66,6 +66,20 @@ module Google
       # a non-empty value will be returned. The user will not be aware of what
       # non-empty value to expect.
       NON_EMPTY_DEFAULT = 7
+
+      # Denotes that the field in a resource (a message annotated with
+      # google.api.resource) is used in the resource name to uniquely identify the
+      # resource. For AIP-compliant APIs, this should only be applied to the
+      # `name` field on the resource.
+      #
+      # This behavior should not be applied to references to other resources within
+      # the message.
+      #
+      # The identifier field of resources often have different field behavior
+      # depending on the request it is embedded in (e.g. for Create methods name
+      # is optional and unused, while for Update methods it is required). Instead
+      # of method-specific annotations, only `IDENTIFIER` is required.
+      IDENTIFIER = 8
     end
   end
 end

data/proto_docs/google/cloud/batch/v1/job.rb

@@ -314,17 +314,14 @@ module Google
           # https://cloud.google.com/compute/docs/disks#localssds.
           # @!attribute [rw] image
           #   @return [::String]
-          #     Name of an image used as the data source.
+          #     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:
-          #     <pre><code>projects/<var
-          #     class="apiparam">project</var>/global/images/family/<var
-          #     class="apiparam">image_family</var></code></pre>
+          #     projects/\\{project}/global/images/family/\\{image_family}
           #     * Specify the image version:
-          #     <pre>projects/<var
-          #     class="apiparam">project</var>/global/images/<var
-          #     class="apiparam">image_version</var></code></pre>
+          #     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:
           #
@@ -346,14 +343,23 @@ module Google
           #   @return [::Integer]
           #     Disk size in GB.
           #
-          #     For persistent disk, this field is ignored if `data_source` is `image` or
-          #     `snapshot`.
-          #     For local SSD, size_gb should be a multiple of 375GB,
-          #     otherwise, the final size will be the next greater multiple of 375 GB.
-          #     For boot disk, Batch will calculate the boot disk size based on source
+          #     **Non-Boot Disk**:
+          #     If the `type` specifies a persistent disk, this field
+          #     is ignored if `data_source` is set as `image` or `snapshot`.
+          #     If the `type` specifies a local SSD, this field should be a multiple of
+          #     375 GB, otherwise, the final size will be the next greater multiple of
+          #     375 GB.
+          #
+          #     **Boot Disk**:
+          #     Batch will calculate the boot disk size based on source
           #     image and task requirements if you do not speicify the size.
-          #     If both this field and the boot_disk_mib field in task spec's
-          #     compute_resource are defined, Batch will only honor this field.
+          #     If both this field and the `boot_disk_mib` field in task spec's
+          #     `compute_resource` are defined, Batch will only honor this field.
+          #     Also, this field should be no smaller than the source disk's
+          #     size when the `data_source` is set as `snapshot` or `image`.
+          #     For example, if you set an image as the `data_source` field and the
+          #     image's default disk size 30 GB, you can only use this field to make the
+          #     disk larger or equal to 30 GB.
           # @!attribute [rw] disk_interface
           #   @return [::String]
           #     Local SSDs are available through both "SCSI" and "NVMe" interfaces.
@@ -432,12 +438,18 @@ module Google
           #   @return [::Array<::Google::Cloud::Batch::V1::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.
+          #     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.
           class InstancePolicy
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Either an InstancePolicy or an instance template.
+          # 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.
           # @!attribute [rw] policy
           #   @return [::Google::Cloud::Batch::V1::AllocationPolicy::InstancePolicy]
           #     InstancePolicy.
@@ -470,30 +482,20 @@ module Google
           #     You can specify the network as a full or partial URL.
           #
           #     For example, the following are all valid URLs:
-          #     <pre><code>https://www.googleapis.com/compute/v1/projects/<var
-          #     class="apiparam">project</var>/global/networks/<var
-          #     class="apiparam">network</var></code></pre>
-          #     <pre><code>projects/<var
-          #     class="apiparam">project</var>/global/networks/<var
-          #     class="apiparam">network</var></code></pre>
-          #     <pre><code>global/networks/<var
-          #     class="apiparam">network</var></code></pre>
+          #
+          #     * https://www.googleapis.com/compute/v1/projects/\\{project}/global/networks/\\{network}
+          #     * projects/\\{project}/global/networks/\\{network}
+          #     * global/networks/\\{network}
           # @!attribute [rw] subnetwork
           #   @return [::String]
           #     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:
-          #     <pre><code>https://www.googleapis.com/compute/v1/projects/<var
-          #     class="apiparam">project</var>/regions/<var
-          #     class="apiparam">region</var>/subnetworks/<var
-          #     class="apiparam">subnetwork</var></code></pre>
-          #     <pre><code>projects/<var class="apiparam">project</var>/regions/<var
-          #     class="apiparam">region</var>/subnetworks/<var
-          #     class="apiparam">subnetwork</var></code></pre>
-          #     <pre><code>regions/<var
-          #     class="apiparam">region</var>/subnetworks/<var
-          #     class="apiparam">subnetwork</var></code></pre>
+          #
+          #     * https://www.googleapis.com/compute/v1/projects/\\{project}/regions/\\{region}/subnetworks/\\{subnetwork}
+          #     * projects/\\{project}/regions/\\{region}/subnetworks/\\{subnetwork}
+          #     * regions/\\{region}/subnetworks/\\{subnetwork}
           # @!attribute [rw] no_external_ip_address
           #   @return [::Boolean]
           #     Default is false (with an external IP address). Required if

data/proto_docs/google/cloud/batch/v1/task.rb

@@ -21,13 +21,51 @@ module Google
   module Cloud
     module Batch
       module V1
-        # Compute resource requirements
+        # 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.
         # @!attribute [rw] cpu_milli
         #   @return [::Integer]
         #     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.
         # @!attribute [rw] memory_mib
         #   @return [::Integer]
         #     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.
         # @!attribute [rw] boot_disk_mib
         #   @return [::Integer]
         #     Extra boot disk size in MiB for each task.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-batch-v1
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.10.5
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -273,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: An API to manage the running of batch jobs on Google Cloud Platform.