docs: Update comments on ServiceAccount email and scopes fields (goog…

…leapis#25472)
mcieaaka · Apr 16, 2024 · db676c3 · db676c3
1 parent 255e7de
commit db676c3
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 9 deletions.
diff --git a/google-cloud-batch-v1/README.md b/google-cloud-batch-v1/README.md
@@ -1,6 +1,6 @@
 # Ruby Client for the Batch V1 API
 
-An API to manage the running of batch resources on Google Cloud Platform.
+An API to manage the running of Batch resources on Google Cloud Platform.
 
 Google Cloud Batch is a fully managed service used by scientists, VFX artists, developers to easily and efficiently run batch workloads on Google Cloud. This service manages provisioning of resources to satisfy the requirements of the batch jobs for a variety of workloads including ML, HPC, VFX rendering, transcoding, genomics and others.
 

diff --git a/google-cloud-batch-v1/google-cloud-batch-v1.gemspec b/google-cloud-batch-v1/google-cloud-batch-v1.gemspec
@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Google LLC"]
   gem.email         = "googleapis-packages@google.com"
   gem.description   = "Google Cloud Batch is a fully managed service used by scientists, VFX artists, developers to easily and efficiently run batch workloads on Google Cloud. This service manages provisioning of resources to satisfy the requirements of the batch jobs for a variety of workloads including ML, HPC, VFX rendering, transcoding, genomics and others. Note that google-cloud-batch-v1 is a version-specific client library. For most uses, we recommend installing the main client library google-cloud-batch instead. See the readme for more details."
-  gem.summary       = "An API to manage the running of batch resources on Google Cloud Platform."
+  gem.summary       = "An API to manage the running of Batch resources on Google Cloud Platform."
   gem.homepage      = "https://github.com/googleapis/google-cloud-ruby"
   gem.license       = "Apache-2.0"
 

diff --git a/google-cloud-batch-v1/proto_docs/google/cloud/batch/v1/job.rb b/google-cloud-batch-v1/proto_docs/google/cloud/batch/v1/job.rb
@@ -288,7 +288,17 @@ module Type
         #     Only instances[0] is supported now.
         # @!attribute [rw] service_account
         #   @return [::Google::Cloud::Batch::V1::ServiceAccount]
-        #     Service account that VMs will run as.
+        #     Defines the service account for Batch-created VMs. If omitted, the [default
+        #     Compute Engine service
+        #     account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
+        #     is used. Must match the service account specified in any used instance
+        #     template configured in the Batch job.
+        #
+        #     Includes the following fields:
+        #      * email: The service account's email address. If not set, the default
+        #      Compute Engine service account is used.
+        #      * scopes: Additional OAuth scopes to grant the service account, beyond the
+        #      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
@@ -688,14 +698,10 @@ module SchedulingPolicy
         # Carries information about a Google Cloud service account.
         # @!attribute [rw] email
         #   @return [::String]
-        #     Email address of the service account. If not specified, the default
-        #     Compute Engine service account for the project will be used. If instance
-        #     template is being used, the service account has to be specified in the
-        #     instance template and it has to match the email field here.
+        #     Email address of the service account.
         # @!attribute [rw] scopes
         #   @return [::Array<::String>]
-        #     List of scopes to be enabled for this service account on the VM, in
-        #     addition to the cloud-platform API scope that will be added by default.
+        #     List of scopes to be enabled for this service account.
         class ServiceAccount
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

diff --git a/google-cloud-batch-v1/proto_docs/google/cloud/batch/v1/task.rb b/google-cloud-batch-v1/proto_docs/google/cloud/batch/v1/task.rb
@@ -352,6 +352,8 @@ class LabelsEntry
         #   @return [::Google::Protobuf::Duration]
         #     Maximum duration the task should run.
         #     The task will be killed and marked as FAILED if over this limit.
+        #     The valid value range for max_run_duration in seconds is [0,
+        #     315576000000.999999999],
         # @!attribute [rw] max_retry_count
         #   @return [::Integer]
         #     Maximum number of retries on failures.