google-apis-batch_v1 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41508d305f309af1cb29aae8b054f55fadb2ee3eba4cb9ec4e3ff6164317d5c6
-  data.tar.gz: d08896147862ae1b23bc13f83cff8e6d82939bc697596d0f88a2a9752dcb3208
+  metadata.gz: e6b5881df8d2a39b16a0421682d569ed713e0ed6c3bc979af79e95592e2d66bd
+  data.tar.gz: 78c7d16eb7530a8a09d51fe711b701e2bec04d449d01db214413dd55892364ba
 SHA512:
-  metadata.gz: b75075f42d40541c2ad6270152229c351e346b35995f2db98c399c6e53583d6c700852865426472dbf60210a6b2d9d24c5bb3c6b9df02c97092289b0bc76be5d
-  data.tar.gz: 2224278cab6fc191dd4b47a6382800e9e45bae090e0b6d8518f0050c5c2ed51df63d396ba93afd40160ad334ef901185eaca3949abcd329ecbc533bf84c25fe9
+  metadata.gz: d1cc7e8f951017449a64ae9a2f524d8a1b4878e1e01d7b7f02704b9a819d870e648695a8411481241b97c2d7eff881c6555669dfeca1948b2383d13c365bfc1c
+  data.tar.gz: eabe063c7491af2ca75c2a6aae19a2dcbcc89394a436053207f0944103dab4c301a270238df69a66afb76bc503b7df84a9e2de9ee4ec4ca613f652cd43c71d38

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-batch_v1
 
+### v0.18.0 (2023-08-13)
+
+* Regenerated from discovery document revision 20230804
+
+### v0.17.0 (2023-08-06)
+
+* Regenerated from discovery document revision 20230726
+
 ### v0.16.0 (2023-07-16)
 
 * Regenerated from discovery document revision 20230705

data/lib/google/apis/batch_v1/classes.rb

@@ -689,7 +689,12 @@ module Google
         end
       end
       
-      # 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.
       class ComputeResource
         include Google::Apis::Core::Hashable
       
@@ -698,12 +703,35 @@ module Google
         # @return [Fixnum]
         attr_accessor :boot_disk_mib
       
-        # 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.
         # Corresponds to the JSON property `cpuMilli`
         # @return [Fixnum]
         attr_accessor :cpu_milli
       
-        # 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.
         # Corresponds to the JSON property `memoryMib`
         # @return [Fixnum]
         attr_accessor :memory_mib
@@ -806,14 +834,14 @@ module Google
         # @return [String]
         attr_accessor :disk_interface
       
-        # 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.
         # Corresponds to the JSON property `image`
         # @return [String]
         attr_accessor :image
@@ -944,7 +972,9 @@ module Google
         attr_accessor :boot_disk
       
         # Non-boot disks to be attached for each VM created by this InstancePolicy. New
-        # disks will be deleted when the VM is deleted.
+        # 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.
         # Corresponds to the JSON property `disks`
         # @return [Array<Google::Apis::BatchV1::AttachedDisk>]
         attr_accessor :disks
@@ -980,7 +1010,10 @@ module Google
         end
       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.
       class InstancePolicyOrTemplate
         include Google::Apis::Core::Hashable
       
@@ -1152,16 +1185,19 @@ module Google
       class JobNotification
         include Google::Apis::Core::Hashable
       
-        # Message details. Describe the attribute that a message should have. Without
-        # specified message attributes, no message will be sent by default.
+        # Message details. Describe the conditions under which messages will be sent. If
+        # no attribute is defined, no message will be sent by default. One message
+        # should specify either the job or the task level attributes, but not both. For
+        # example, job level: JOB_STATE_CHANGED and/or a specified new_job_state; task
+        # level: TASK_STATE_CHANGED and/or a specified new_task_state.
         # Corresponds to the JSON property `message`
         # @return [Google::Apis::BatchV1::Message]
         attr_accessor :message
       
         # The Pub/Sub topic where notifications like the job state changes will be
-        # published. This topic exist in the same project as the job and billings will
-        # be charged to this project. If not specified, no Pub/Sub messages will be sent.
-        # Topic format: `projects/`project`/topics/`topic``.
+        # published. The topic must exist in the same project as the job and billings
+        # will be charged to this project. If not specified, no Pub/Sub messages will be
+        # sent. Topic format: `projects/`project`/topics/`topic``.
         # Corresponds to the JSON property `pubsubTopic`
         # @return [String]
         attr_accessor :pubsub_topic
@@ -1482,8 +1518,11 @@ module Google
         end
       end
       
-      # Message details. Describe the attribute that a message should have. Without
-      # specified message attributes, no message will be sent by default.
+      # Message details. Describe the conditions under which messages will be sent. If
+      # no attribute is defined, no message will be sent by default. One message
+      # should specify either the job or the task level attributes, but not both. For
+      # example, job level: JOB_STATE_CHANGED and/or a specified new_job_state; task
+      # level: TASK_STATE_CHANGED and/or a specified new_task_state.
       class Message
         include Google::Apis::Core::Hashable
       
@@ -1544,9 +1583,9 @@ module Google
         include Google::Apis::Core::Hashable
       
         # 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
+        # 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`
         # Corresponds to the JSON property `network`
         # @return [String]
         attr_accessor :network
@@ -1563,9 +1602,9 @@ module Google
       
         # 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
+        # URLs: * https://www.googleapis.com/compute/v1/projects/`project`/regions/`
+        # region`/subnetworks/`subnetwork` * projects/`project`/regions/`region`/
+        # subnetworks/`subnetwork` * regions/`region`/subnetworks/`subnetwork`
         # Corresponds to the JSON property `subnetwork`
         # @return [String]
         attr_accessor :subnetwork
@@ -1638,13 +1677,13 @@ module Google
         # @return [String]
         attr_accessor :name
       
-        # 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`.
         # Corresponds to the JSON property `response`
         # @return [Hash<String,Object>]
         attr_accessor :response
@@ -2205,7 +2244,12 @@ module Google
       class TaskSpec
         include Google::Apis::Core::Hashable
       
-        # 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.
         # Corresponds to the JSON property `computeResource`
         # @return [Google::Apis::BatchV1::ComputeResource]
         attr_accessor :compute_resource

data/lib/google/apis/batch_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module BatchV1
       # Version of the google-apis-batch_v1 gem
-      GEM_VERSION = "0.16.0"
+      GEM_VERSION = "0.18.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230705"
+      REVISION = "20230804"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-batch_v1
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-16 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-batch_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-batch_v1/v0.16.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-batch_v1/v0.18.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-batch_v1
 post_install_message: 
 rdoc_options: []