google-apis-batch_v1 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e091421f7fe7aa14c44ebe508e801845f7ad48defdbd98c931d7df94c8abafb6
-  data.tar.gz: 45f952d90c8938c7d0628139046a86d0ea6f89a24726513416e93b56e5b161e7
+  metadata.gz: 2b3d209afde40ee78754a82b7520ecfcfbcb27bdf98f9dc3859ea172e5d33d2b
+  data.tar.gz: ed5d209e4b71da3c749b30b7974eb35137073edb73922e63be8b469f00aa81fa
 SHA512:
-  metadata.gz: 739b2e9f4481ecbb46999fe394de1a57b8b3279afc9f5e983cded9e68b9621379f8c7fd89d9c7731570c8704a73ffdc4b794bcd72f4d8ea0ef5fddc7ed287755
-  data.tar.gz: 21a7c4dbb5d94ae5146f5c979becee8ccad6baa579d98f8de78606b813825de84e33095c965970990fe0ddcce099e129107e127fb1220619a457ac235dab4eaa
+  metadata.gz: bf039f0877365b9acfeae4f38a449740f79321abdab05336a8f27c94859aaaa141c90d65c53ee2eb644102fe541db19d57865894d7b4c8ceae7c3a48f028516f
+  data.tar.gz: 86255bcc0df04bb152d0ca84249d0eb1581b172d63fdbf657e2c49b34aebcd41e75cdc05ccb7e5463d63600f0954e47e4c3d506f8b77d0420bc5772f7b172bd3

data/CHANGELOG.md

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

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

@@ -31,6 +31,15 @@ module Google
         # @return [Fixnum]
         attr_accessor :count
       
+        # Optional. The NVIDIA GPU driver version that should be installed for this type.
+        # You can define the specific driver version such as "470.103.01", following
+        # the driver version requirements in https://cloud.google.com/compute/docs/gpus/
+        # install-drivers-gpu#minimum-driver. Batch will install the specific
+        # accelerator driver if qualified.
+        # Corresponds to the JSON property `driverVersion`
+        # @return [String]
+        attr_accessor :driver_version
+      
         # Deprecated: please use instances[0].install_gpu_drivers instead.
         # Corresponds to the JSON property `installGpuDrivers`
         # @return [Boolean]
@@ -50,6 +59,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @count = args[:count] if args.key?(:count)
+          @driver_version = args[:driver_version] if args.key?(:driver_version)
           @install_gpu_drivers = args[:install_gpu_drivers] if args.key?(:install_gpu_drivers)
           @type = args[:type] if args.key?(:type)
         end
@@ -162,7 +172,7 @@ module Google
       class AgentInfo
         include Google::Apis::Core::Hashable
       
-        # The assigned Job ID
+        # Optional. The assigned Job ID
         # Corresponds to the JSON property `jobId`
         # @return [String]
         attr_accessor :job_id
@@ -679,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
       
@@ -688,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
@@ -796,14 +834,14 @@ module Google
         # @return [String]
         attr_accessor :disk_interface
       
-        # Name of a public or custom 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.
+        # 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.
         # Corresponds to the JSON property `image`
         # @return [String]
         attr_accessor :image
@@ -934,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 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.
         # Corresponds to the JSON property `disks`
         # @return [Array<Google::Apis::BatchV1::AttachedDisk>]
         attr_accessor :disks
@@ -970,13 +1010,21 @@ 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
       
         # Set this field true if users want Batch to help fetch drivers from a third
         # party location and install them for GPUs specified in policy.accelerators or
-        # instance_template on their behalf. Default is false.
+        # instance_template on their behalf. Default is false. For Container-Optimized
+        # Image cases, Batch will install the accelerator driver following milestones of
+        # https://cloud.google.com/container-optimized-os/docs/release-notes. For non
+        # Container-Optimized Image cases, following https://github.com/
+        # GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/
+        # install_gpu_driver.py.
         # Corresponds to the JSON property `installGpuDrivers`
         # @return [Boolean]
         attr_accessor :install_gpu_drivers
@@ -1137,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
@@ -1467,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
       
@@ -1529,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
@@ -1548,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
@@ -2190,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.15.0"
+      GEM_VERSION = "0.17.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 = "20230607"
+      REVISION = "20230726"
     end
   end
 end

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

@@ -380,6 +380,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :count, :numeric_string => true, as: 'count'
+          property :driver_version, as: 'driverVersion'
           property :install_gpu_drivers, as: 'installGpuDrivers'
           property :type, as: 'type'
         end

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

@@ -256,6 +256,9 @@ module Google
         #   Parent path.
         # @param [String] filter
         #   List filter.
+        # @param [String] order_by
+        #   Optional. Sort results. Supported are "name", "name desc", "create_time", and "
+        #   create_time desc".
         # @param [Fixnum] page_size
         #   Page size.
         # @param [String] page_token
@@ -277,12 +280,13 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def list_project_location_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+        def list_project_location_jobs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v1/{+parent}/jobs', options)
           command.response_representation = Google::Apis::BatchV1::ListJobsResponse::Representation
           command.response_class = Google::Apis::BatchV1::ListJobsResponse
           command.params['parent'] = parent unless parent.nil?
           command.query['filter'] = filter unless filter.nil?
+          command.query['orderBy'] = order_by unless order_by.nil?
           command.query['pageSize'] = page_size unless page_size.nil?
           command.query['pageToken'] = page_token unless page_token.nil?
           command.query['fields'] = fields unless fields.nil?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-batch_v1
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-18 00:00:00.000000000 Z
+date: 2023-08-06 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.15.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-batch_v1/v0.17.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-batch_v1
 post_install_message: 
 rdoc_options: []