google-cloud-batch-v1 0.19.1 → 0.20.0

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

@@ -44,16 +44,18 @@ module Google
         #     Compute resource allocation for all TaskGroups in the Job.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
-        #     Labels for the Job. Labels could be user provided or system generated.
-        #     For example,
-        #     "labels": {
-        #        "department": "finance",
-        #        "environment": "test"
-        #      }
-        #     You can assign up to 64 labels.  [Google Compute Engine label
-        #     restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
-        #     apply.
-        #     Label names that start with "goog-" or "google-" are reserved.
+        #     Custom labels to apply to the job and any Cloud Logging
+        #     [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)
+        #     that it generates.
+        #
+        #     Use labels to group and describe the resources they are applied to. Batch
+        #     automatically applies predefined labels and supports multiple `labels`
+        #     fields for each job, which each let you apply custom labels to various
+        #     resources. Label names that start with "goog-" or "google-" are
+        #     reserved for predefined labels. For more information about labels with
+        #     Batch, see
+        #     [Organize resources using
+        #     labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
         # @!attribute [r] status
         #   @return [::Google::Cloud::Batch::V1::JobStatus]
         #     Output only. Job status. It is read only for users.
@@ -83,20 +85,27 @@ module Google
           end
         end
 
-        # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be
-        # preserved.
+        # LogsPolicy describes if and how a job's logs are preserved. Logs include
+        # information that is automatically written by the Batch service agent and any
+        # information that you configured the job's runnables to write to the `stdout`
+        # or `stderr` streams.
         # @!attribute [rw] destination
         #   @return [::Google::Cloud::Batch::V1::LogsPolicy::Destination]
-        #     Where logs should be saved.
+        #     If and where logs should be saved.
         # @!attribute [rw] logs_path
         #   @return [::String]
-        #     The path to which logs are saved when the destination = PATH. This can be a
-        #     local file path on the VM, or under the mount point of a Persistent Disk or
-        #     Filestore, or a Cloud Storage path.
+        #     When `destination` is set to `PATH`, you must set this field to the path
+        #     where you want logs to be saved. This path can point to a local directory
+        #     on the VM or (if congifured) a directory under the mount path of any
+        #     Cloud Storage bucket, network file system (NFS), or writable persistent
+        #     disk that is mounted to the job. For example, if the job has a bucket with
+        #     `mountPath` set to `/mnt/disks/my-bucket`, you can write logs to the
+        #     root directory of the `remotePath` of that bucket by setting this field to
+        #     `/mnt/disks/my-bucket/`.
         # @!attribute [rw] cloud_logging_option
         #   @return [::Google::Cloud::Batch::V1::LogsPolicy::CloudLoggingOption]
-        #     Optional. Additional settings for Cloud Logging. It will only take effect
-        #     when the destination of `LogsPolicy` is set to `CLOUD_LOGGING`.
+        #     Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally
+        #     set this field to configure additional settings for Cloud Logging.
         class LogsPolicy
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -105,7 +114,7 @@ module Google
           # generated by Batch job.
           # @!attribute [rw] use_generic_task_monitored_resource
           #   @return [::Boolean]
-          #     Optional. Set this flag to true to change the [monitored resource
+          #     Optional. Set this field to `true` to change the [monitored resource
           #     type](https://cloud.google.com/monitoring/api/resources) for
           #     Cloud Logging logs generated by this Batch job from
           #     the
@@ -120,13 +129,14 @@ module Google
 
           # The destination (if any) for logs.
           module Destination
-            # Logs are not preserved.
+            # (Default) Logs are not preserved.
             DESTINATION_UNSPECIFIED = 0
 
-            # Logs are streamed to Cloud Logging.
+            # Logs are streamed to Cloud Logging. Optionally, you can configure
+            # additional settings in the `cloudLoggingOption` field.
             CLOUD_LOGGING = 1
 
-            # Logs are saved to a file path.
+            # Logs are saved to the file path specified in the `logsPath` field.
             PATH = 2
           end
         end
@@ -309,13 +319,17 @@ module Google
         #      default cloud-platform scope. (list of strings)
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
-        #     Labels applied to all VM instances and other resources
-        #     created by AllocationPolicy.
-        #     Labels could be user provided or system generated.
-        #     You can assign up to 64 labels. [Google Compute Engine label
-        #     restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
-        #     apply.
-        #     Label names that start with "goog-" or "google-" are reserved.
+        #     Custom labels to apply to the job and all the Compute Engine resources
+        #     that both are created by this allocation policy and support labels.
+        #
+        #     Use labels to group and describe the resources they are applied to. Batch
+        #     automatically applies predefined labels and supports multiple `labels`
+        #     fields for each job, which each let you apply custom labels to various
+        #     resources. Label names that start with "goog-" or "google-" are
+        #     reserved for predefined labels. For more information about labels with
+        #     Batch, see
+        #     [Organize resources using
+        #     labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
         # @!attribute [rw] network
         #   @return [::Google::Cloud::Batch::V1::AllocationPolicy::NetworkPolicy]
         #     The network policy.
@@ -497,8 +511,10 @@ module Google
           #     storage and accessing.
           # @!attribute [rw] reservation
           #   @return [::String]
-          #     Optional. If specified, VMs will consume only the specified reservation.
-          #     If not specified (default), VMs will consume any applicable reservation.
+          #     Optional. If not specified (default), VMs will consume any applicable
+          #     reservation. If "NO_RESERVATION" is specified, VMs will not consume any
+          #     reservation. Otherwise, if specified, VMs will consume only the specified
+          #     reservation.
           class InstancePolicy
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -517,7 +533,8 @@ module Google
           #     Named the field as 'instance_template' instead of 'template' to avoid
           #     C++ keyword conflict.
           #
-          #     Batch only supports global instance templates.
+          #     Batch only supports global instance templates from the same project as
+          #     the job.
           #     You can specify the global instance template as a full or partial URL.
           # @!attribute [rw] install_gpu_drivers
           #   @return [::Boolean]

data/proto_docs/google/longrunning/operations.rb

@@ -42,7 +42,7 @@ module Google
     #     The error result of the operation in case of failure or cancellation.
     # @!attribute [rw] response
     #   @return [::Google::Protobuf::Any]
-    #     The normal response of the operation in case of success.  If the original
+    #     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
@@ -55,7 +55,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.GetOperation.
+    # The request message for
+    # Operations.GetOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource.
@@ -64,7 +65,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.ListOperations.
+    # The request message for
+    # Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation's parent resource.
@@ -82,7 +84,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The response message for Operations.ListOperations.
+    # The response message for
+    # Operations.ListOperations.
     # @!attribute [rw] operations
     #   @return [::Array<::Google::Longrunning::Operation>]
     #     A list of operations that matches the specified filter in the request.
@@ -94,7 +97,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.CancelOperation.
+    # The request message for
+    # Operations.CancelOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to be cancelled.
@@ -103,7 +107,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.DeleteOperation.
+    # The request message for
+    # Operations.DeleteOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to be deleted.
@@ -112,7 +117,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.WaitOperation.
+    # The request message for
+    # Operations.WaitOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to wait on.
@@ -130,13 +136,12 @@ module Google
     #
     # Example:
     #
-    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
-    #       returns (google.longrunning.Operation) {
-    #     option (google.longrunning.operation_info) = {
-    #       response_type: "LongRunningRecognizeResponse"
-    #       metadata_type: "LongRunningRecognizeMetadata"
-    #     };
-    #   }
+    #     rpc Export(ExportRequest) returns (google.longrunning.Operation) {
+    #       option (google.longrunning.operation_info) = {
+    #         response_type: "ExportResponse"
+    #         metadata_type: "ExportMetadata"
+    #       };
+    #     }
     # @!attribute [rw] response_type
     #   @return [::String]
     #     Required. The message name of the primary return type for this

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-batch-v1
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: An API to manage the running of Batch resources on Google Cloud Platform.