Skip to content

Commit db676c3

Browse files
docs: Update comments on ServiceAccount email and scopes fields (googleapis#25472)
1 parent 255e7de commit db676c3

4 files changed

Lines changed: 17 additions & 9 deletions

File tree

google-cloud-batch-v1/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Ruby Client for the Batch V1 API
22

3-
An API to manage the running of batch resources on Google Cloud Platform.
3+
An API to manage the running of Batch resources on Google Cloud Platform.
44

55
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.
66

google-cloud-batch-v1/google-cloud-batch-v1.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
1010
gem.authors = ["Google LLC"]
1111
gem.email = "googleapis-packages@google.com"
1212
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."
13-
gem.summary = "An API to manage the running of batch resources on Google Cloud Platform."
13+
gem.summary = "An API to manage the running of Batch resources on Google Cloud Platform."
1414
gem.homepage = "https://github.com/googleapis/google-cloud-ruby"
1515
gem.license = "Apache-2.0"
1616

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

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,17 @@ module Type
288288
# Only instances[0] is supported now.
289289
# @!attribute [rw] service_account
290290
# @return [::Google::Cloud::Batch::V1::ServiceAccount]
291-
# Service account that VMs will run as.
291+
# Defines the service account for Batch-created VMs. If omitted, the [default
292+
# Compute Engine service
293+
# account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
294+
# is used. Must match the service account specified in any used instance
295+
# template configured in the Batch job.
296+
#
297+
# Includes the following fields:
298+
# * email: The service account's email address. If not set, the default
299+
# Compute Engine service account is used.
300+
# * scopes: Additional OAuth scopes to grant the service account, beyond the
301+
# default cloud-platform scope. (list of strings)
292302
# @!attribute [rw] labels
293303
# @return [::Google::Protobuf::Map{::String => ::String}]
294304
# Labels applied to all VM instances and other resources
@@ -688,14 +698,10 @@ module SchedulingPolicy
688698
# Carries information about a Google Cloud service account.
689699
# @!attribute [rw] email
690700
# @return [::String]
691-
# Email address of the service account. If not specified, the default
692-
# Compute Engine service account for the project will be used. If instance
693-
# template is being used, the service account has to be specified in the
694-
# instance template and it has to match the email field here.
701+
# Email address of the service account.
695702
# @!attribute [rw] scopes
696703
# @return [::Array<::String>]
697-
# List of scopes to be enabled for this service account on the VM, in
698-
# addition to the cloud-platform API scope that will be added by default.
704+
# List of scopes to be enabled for this service account.
699705
class ServiceAccount
700706
include ::Google::Protobuf::MessageExts
701707
extend ::Google::Protobuf::MessageExts::ClassMethods

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,8 @@ class LabelsEntry
352352
# @return [::Google::Protobuf::Duration]
353353
# Maximum duration the task should run.
354354
# The task will be killed and marked as FAILED if over this limit.
355+
# The valid value range for max_run_duration in seconds is [0,
356+
# 315576000000.999999999],
355357
# @!attribute [rw] max_retry_count
356358
# @return [::Integer]
357359
# Maximum number of retries on failures.

0 commit comments

Comments
 (0)