google-apis-batch_v1 0.27.0 → 0.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1c3799c8c31ca7ef1be0696d15be378b25cf366dd32140c3667d99a59d99f405
4
- data.tar.gz: dfa0bbe699770b4074ca1faa7a58cccc8d0d1cd67a9c13d00436a381883d41e7
3
+ metadata.gz: 0e9d85f5743c9efff93b66cb30f3b43fd966ff658a119d86568e995338c1a8c6
4
+ data.tar.gz: 470aa2aa03e88a7de3f9ca4add17084e3b9372121e3ec1fbd32ef467e567e14f
5
5
  SHA512:
6
- metadata.gz: cf0faa4090a3b9133f16e110fbb04152dd6075b0911165d392253cdab0a6a3bb13ea44671ec99efeae7ae19f2be0c6de7bb0f5a7a6c708ef16b0490bc95a37fa
7
- data.tar.gz: 7255ca2ab1b9ba8045e5eea464e46c825032b5bba319052f016e8ab800c9d2d2e8d7c9ff1721ffabff34a768ddb5626977428611d4ad84e4c2db1daedcb8886f
6
+ metadata.gz: 5b7fd12fd3d41e14118b635a01570910686b7a0dc91d75e0dd81376825efd42b07289f605297657d4298a21cb9febdbddb579a6a5569ad8a3ad77299cfd151e1
7
+ data.tar.gz: 7145dc94035224c080e7b2e16938a922bc06fd93fa4498798606ae5cd86c1bd43f7f580dff4164819dbcb8333ee696bf67b991f20d650f2f1d8128cd1e50610c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # Release history for google-apis-batch_v1
2
2
 
3
+ ### v0.29.0 (2024-02-04)
4
+
5
+ * Regenerated from discovery document revision 20240127
6
+ * Regenerated using generator version 0.13.1
7
+
8
+ ### v0.28.0 (2024-01-23)
9
+
10
+ * Regenerated from discovery document revision 20240112
11
+ * Regenerated using generator version 0.13.0
12
+
3
13
  ### v0.27.0 (2024-01-07)
4
14
 
5
15
  * Regenerated from discovery document revision 20231213
@@ -316,7 +316,7 @@ module Google
316
316
  # the first line of the file.(For example, to execute the script using bash, `#!/
317
317
  # bin/bash` should be the first line of the file. To execute the script using`
318
318
  # Python3`, `#!/usr/bin/env python3` should be the first line of the file.)
319
- # Otherwise, the file will by default be excuted by `/bin/sh`.
319
+ # Otherwise, the file will by default be executed by `/bin/sh`.
320
320
  # Corresponds to the JSON property `path`
321
321
  # @return [String]
322
322
  attr_accessor :path
@@ -324,7 +324,7 @@ module Google
324
324
  # Shell script text. To specify an interpreter, please add a `#!\n` at the
325
325
  # beginning of the text.(For example, to execute the script using bash, `#!/bin/
326
326
  # bash\n` should be added. To execute the script using`Python3`, `#!/usr/bin/env
327
- # python3\n` should be added.) Otherwise, the script will by default be excuted
327
+ # python3\n` should be added.) Otherwise, the script will by default be executed
328
328
  # by `/bin/sh`.
329
329
  # Corresponds to the JSON property `text`
330
330
  # @return [String]
@@ -732,6 +732,32 @@ module Google
732
732
  end
733
733
  end
734
734
 
735
+ # `CloudLoggingOption` contains additional settings for Cloud Logging logs
736
+ # generated by Batch job.
737
+ class CloudLoggingOption
738
+ include Google::Apis::Core::Hashable
739
+
740
+ # Optional. Set this flag to true to change the [monitored resource type](https:/
741
+ # /cloud.google.com/monitoring/api/resources) for Cloud Logging logs generated
742
+ # by this Batch job from the [`batch.googleapis.com/Job`](https://cloud.google.
743
+ # com/monitoring/api/resources#tag_batch.googleapis.com/Job) type to the
744
+ # formerly used [`generic_task`](https://cloud.google.com/monitoring/api/
745
+ # resources#tag_generic_task) type.
746
+ # Corresponds to the JSON property `useGenericTaskMonitoredResource`
747
+ # @return [Boolean]
748
+ attr_accessor :use_generic_task_monitored_resource
749
+ alias_method :use_generic_task_monitored_resource?, :use_generic_task_monitored_resource
750
+
751
+ def initialize(**args)
752
+ update!(**args)
753
+ end
754
+
755
+ # Update properties of this object
756
+ def update!(**args)
757
+ @use_generic_task_monitored_resource = args[:use_generic_task_monitored_resource] if args.key?(:use_generic_task_monitored_resource)
758
+ end
759
+ end
760
+
735
761
  # Compute resource requirements. ComputeResource defines the amount of resources
736
762
  # required for each task. Make sure your tasks have enough resources to
737
763
  # successfully run. If you also define the types of resources for a job to use
@@ -810,12 +836,17 @@ module Google
810
836
  # @return [Array<String>]
811
837
  attr_accessor :commands
812
838
 
813
- # Optional. If set to true, container will run with Image streaming. The
814
- # container runtime will be changed to containerd instead of docker. Currently,
815
- # only imageUri, commands, entrypoint and volumes are supported and any other
816
- # fields will be ignored. Please refer [here](https://github.com/
817
- # GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming) for
818
- # the feature requirements and limitations.
839
+ # Optional. If set to true, this container runnable uses Image streaming. Use
840
+ # Image streaming to allow the runnable to initialize without waiting for the
841
+ # entire container image to download, which can significantly reduce startup
842
+ # time for large container images. When `enableImageStreaming` is set to true,
843
+ # the container runtime is [containerd](https://containerd.io/) instead of
844
+ # Docker. Additionally, this container runnable only supports the following `
845
+ # container` subfields: `imageUri`, `commands[]`, `entrypoint`, and `volumes[]`;
846
+ # any other `container` subfields are ignored. For more information about the
847
+ # requirements and limitations for using Image streaming with Batch, see the [`
848
+ # image-streaming` sample on GitHub](https://github.com/GoogleCloudPlatform/
849
+ # batch-samples/tree/main/api-samples/image-streaming).
819
850
  # Corresponds to the JSON property `enableImageStreaming`
820
851
  # @return [Boolean]
821
852
  attr_accessor :enable_image_streaming
@@ -837,16 +868,30 @@ module Google
837
868
  # @return [String]
838
869
  attr_accessor :options
839
870
 
840
- # Optional password for logging in to a docker registry. If password matches `
841
- # projects/*/secrets/*/versions/*` then Batch will read the password from the
842
- # Secret Manager;
871
+ # Required if the container image is from a private Docker registry. The
872
+ # password to login to the Docker registry that contains the image. For security,
873
+ # it is strongly recommended to specify an encrypted password by using a Secret
874
+ # Manager secret: `projects/*/secrets/*/versions/*`. Warning: If you specify the
875
+ # password using plain text, you risk the password being exposed to any users
876
+ # who can view the job or its logs. To avoid this risk, specify a secret that
877
+ # contains the password instead. Learn more about [Secret Manager](https://cloud.
878
+ # google.com/secret-manager/docs/) and [using Secret Manager with Batch](https://
879
+ # cloud.google.com/batch/docs/create-run-job-secret-manager).
843
880
  # Corresponds to the JSON property `password`
844
881
  # @return [String]
845
882
  attr_accessor :password
846
883
 
847
- # Optional username for logging in to a docker registry. If username matches `
848
- # projects/*/secrets/*/versions/*` then Batch will read the username from the
849
- # Secret Manager.
884
+ # Required if the container image is from a private Docker registry. The
885
+ # username to login to the Docker registry that contains the image. You can
886
+ # either specify the username directly by using plain text or specify an
887
+ # encrypted username by using a Secret Manager secret: `projects/*/secrets/*/
888
+ # versions/*`. However, using a secret is recommended for enhanced security.
889
+ # Caution: If you specify the username using plain text, you risk the username
890
+ # being exposed to any users who can view the job or its logs. To avoid this
891
+ # risk, specify a secret that contains the username instead. Learn more about [
892
+ # Secret Manager](https://cloud.google.com/secret-manager/docs/) and [using
893
+ # Secret Manager with Batch](https://cloud.google.com/batch/docs/create-run-job-
894
+ # secret-manager).
850
895
  # Corresponds to the JSON property `username`
851
896
  # @return [String]
852
897
  attr_accessor :username
@@ -1571,6 +1616,12 @@ module Google
1571
1616
  class LogsPolicy
1572
1617
  include Google::Apis::Core::Hashable
1573
1618
 
1619
+ # `CloudLoggingOption` contains additional settings for Cloud Logging logs
1620
+ # generated by Batch job.
1621
+ # Corresponds to the JSON property `cloudLoggingOption`
1622
+ # @return [Google::Apis::BatchV1::CloudLoggingOption]
1623
+ attr_accessor :cloud_logging_option
1624
+
1574
1625
  # Where logs should be saved.
1575
1626
  # Corresponds to the JSON property `destination`
1576
1627
  # @return [String]
@@ -1589,6 +1640,7 @@ module Google
1589
1640
 
1590
1641
  # Update properties of this object
1591
1642
  def update!(**args)
1643
+ @cloud_logging_option = args[:cloud_logging_option] if args.key?(:cloud_logging_option)
1592
1644
  @destination = args[:destination] if args.key?(:destination)
1593
1645
  @logs_path = args[:logs_path] if args.key?(:logs_path)
1594
1646
  end
@@ -2038,7 +2090,7 @@ module Google
2038
2090
  # the first line of the file.(For example, to execute the script using bash, `#!/
2039
2091
  # bin/bash` should be the first line of the file. To execute the script using`
2040
2092
  # Python3`, `#!/usr/bin/env python3` should be the first line of the file.)
2041
- # Otherwise, the file will by default be excuted by `/bin/sh`.
2093
+ # Otherwise, the file will by default be executed by `/bin/sh`.
2042
2094
  # Corresponds to the JSON property `path`
2043
2095
  # @return [String]
2044
2096
  attr_accessor :path
@@ -2046,7 +2098,7 @@ module Google
2046
2098
  # Shell script text. To specify an interpreter, please add a `#!\n` at the
2047
2099
  # beginning of the text.(For example, to execute the script using bash, `#!/bin/
2048
2100
  # bash\n` should be added. To execute the script using`Python3`, `#!/usr/bin/env
2049
- # python3\n` should be added.) Otherwise, the script will by default be excuted
2101
+ # python3\n` should be added.) Otherwise, the script will by default be executed
2050
2102
  # by `/bin/sh`.
2051
2103
  # Corresponds to the JSON property `text`
2052
2104
  # @return [String]
@@ -2251,12 +2303,22 @@ module Google
2251
2303
 
2252
2304
  # When true, Batch will populate a file with a list of all VMs assigned to the
2253
2305
  # TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of
2254
- # that file. Defaults to false.
2306
+ # that file. Defaults to false. The host file supports up to 1000 VMs.
2255
2307
  # Corresponds to the JSON property `requireHostsFile`
2256
2308
  # @return [Boolean]
2257
2309
  attr_accessor :require_hosts_file
2258
2310
  alias_method :require_hosts_file?, :require_hosts_file
2259
2311
 
2312
+ # Optional. If not set or set to false, Batch uses the root user to execute
2313
+ # runnables. If set to true, Batch runs the runnables using a non-root user.
2314
+ # Currently, the non-root user Batch used is generated by OS Login. For more
2315
+ # information, see [About OS Login](https://cloud.google.com/compute/docs/
2316
+ # oslogin).
2317
+ # Corresponds to the JSON property `runAsNonRoot`
2318
+ # @return [Boolean]
2319
+ attr_accessor :run_as_non_root
2320
+ alias_method :run_as_non_root?, :run_as_non_root
2321
+
2260
2322
  # Scheduling policy for Tasks in the TaskGroup. The default value is
2261
2323
  # AS_SOON_AS_POSSIBLE.
2262
2324
  # Corresponds to the JSON property `schedulingPolicy`
@@ -2302,6 +2364,7 @@ module Google
2302
2364
  @parallelism = args[:parallelism] if args.key?(:parallelism)
2303
2365
  @permissive_ssh = args[:permissive_ssh] if args.key?(:permissive_ssh)
2304
2366
  @require_hosts_file = args[:require_hosts_file] if args.key?(:require_hosts_file)
2367
+ @run_as_non_root = args[:run_as_non_root] if args.key?(:run_as_non_root)
2305
2368
  @scheduling_policy = args[:scheduling_policy] if args.key?(:scheduling_policy)
2306
2369
  @task_count = args[:task_count] if args.key?(:task_count)
2307
2370
  @task_count_per_node = args[:task_count_per_node] if args.key?(:task_count_per_node)
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module BatchV1
18
18
  # Version of the google-apis-batch_v1 gem
19
- GEM_VERSION = "0.27.0"
19
+ GEM_VERSION = "0.29.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.12.0"
22
+ GENERATOR_VERSION = "0.13.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20231213"
25
+ REVISION = "20240127"
26
26
  end
27
27
  end
28
28
  end
@@ -130,6 +130,12 @@ module Google
130
130
  include Google::Apis::Core::JsonObjectSupport
131
131
  end
132
132
 
133
+ class CloudLoggingOption
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
133
139
  class ComputeResource
134
140
  class Representation < Google::Apis::Core::JsonRepresentation; end
135
141
 
@@ -576,6 +582,13 @@ module Google
576
582
  end
577
583
  end
578
584
 
585
+ class CloudLoggingOption
586
+ # @private
587
+ class Representation < Google::Apis::Core::JsonRepresentation
588
+ property :use_generic_task_monitored_resource, as: 'useGenericTaskMonitoredResource'
589
+ end
590
+ end
591
+
579
592
  class ComputeResource
580
593
  # @private
581
594
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -790,6 +803,8 @@ module Google
790
803
  class LogsPolicy
791
804
  # @private
792
805
  class Representation < Google::Apis::Core::JsonRepresentation
806
+ property :cloud_logging_option, as: 'cloudLoggingOption', class: Google::Apis::BatchV1::CloudLoggingOption, decorator: Google::Apis::BatchV1::CloudLoggingOption::Representation
807
+
793
808
  property :destination, as: 'destination'
794
809
  property :logs_path, as: 'logsPath'
795
810
  end
@@ -965,6 +980,7 @@ module Google
965
980
  property :parallelism, :numeric_string => true, as: 'parallelism'
966
981
  property :permissive_ssh, as: 'permissiveSsh'
967
982
  property :require_hosts_file, as: 'requireHostsFile'
983
+ property :run_as_non_root, as: 'runAsNonRoot'
968
984
  property :scheduling_policy, as: 'schedulingPolicy'
969
985
  property :task_count, :numeric_string => true, as: 'taskCount'
970
986
  property :task_count_per_node, :numeric_string => true, as: 'taskCountPerNode'
@@ -22,7 +22,7 @@ module Google
22
22
  module BatchV1
23
23
  # Batch API
24
24
  #
25
- # An API to manage the running of batch jobs on Google Cloud Platform.
25
+ # An API to manage the running of batch resources on Google Cloud Platform.
26
26
  #
27
27
  # @example
28
28
  # require 'google/apis/batch_v1'
@@ -32,6 +32,8 @@ module Google
32
32
  #
33
33
  # @see https://cloud.google.com/batch/
34
34
  class BatchService < Google::Apis::Core::BaseService
35
+ DEFAULT_ENDPOINT_TEMPLATE = "https://batch.$UNIVERSE_DOMAIN$/"
36
+
35
37
  # @return [String]
36
38
  # API key. Your API key identifies your project and provides you with API access,
37
39
  # quota, and reports. Required unless you provide an OAuth 2.0 token.
@@ -43,7 +45,7 @@ module Google
43
45
  attr_accessor :quota_user
44
46
 
45
47
  def initialize
46
- super('https://batch.googleapis.com/', '',
48
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
47
49
  client_name: 'google-apis-batch_v1',
48
50
  client_version: Google::Apis::BatchV1::GEM_VERSION)
49
51
  @batch_path = 'batch'
@@ -21,7 +21,7 @@ module Google
21
21
  module Apis
22
22
  # Batch API
23
23
  #
24
- # An API to manage the running of batch jobs on Google Cloud Platform.
24
+ # An API to manage the running of batch resources on Google Cloud Platform.
25
25
  #
26
26
  # @see https://cloud.google.com/batch/
27
27
  module BatchV1
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-batch_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.27.0
4
+ version: 0.29.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-01-07 00:00:00.000000000 Z
11
+ date: 2024-02-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.11.0
19
+ version: 0.12.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.11.0
29
+ version: 0.12.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-batch_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-batch_v1/v0.27.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-batch_v1/v0.29.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-batch_v1
63
63
  post_install_message:
64
64
  rdoc_options: []