google-cloud-batch-v1 0.18.0 → 0.18.2

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: eeec030e194afbb380afc6822b693b9219c79b0a6320c6b16bb38c42d762bd40
4
- data.tar.gz: a5ac3933b17a3153c73903ba77ab8756bbd8fb195d84daf7a6b4272810eadac1
3
+ metadata.gz: c9a3a810dd582f7a409705d10e3c87cb9a0dbf67d249b327584b1ac7d9f865b2
4
+ data.tar.gz: 59bc014e61610463889e164df17cac91de4ad5afb244197a6642e6e81e201efd
5
5
  SHA512:
6
- metadata.gz: 21a8ed3c3cff033ff9738f018cb3da28d81d5fdb7ec456a21cfdf338657535e47df159459d7e80847ea191fef3cab4d325fe572b36e191bc26aeccf1297edf69
7
- data.tar.gz: bd3a51312fd790a0b1f3090bb3497ac6df77099c4cf57de949e7b16d6a4b2e217148b886c2abdca52c08023350d49da618b8e42a4161faf0ef08e31d3c060656
6
+ metadata.gz: 2f2446afab1cbe8050d02895496c074aa4d4fb78945777c0518e1e4fd811db1ba08d47f526bfc31a323d77a387eb5a27e20ee25a4a95ee6b71fabd3c06c26a4f
7
+ data.tar.gz: 4ef67ebdc8e9a905c75fb9270034ac82f42422999ad7260dd8691abb681a8aea1a41521502a6c6da5303beb5b8c3e21c80f17024fdfcc68351e71b1782e95eef
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Batch
23
23
  module V1
24
- VERSION = "0.18.0"
24
+ VERSION = "0.18.2"
25
25
  end
26
26
  end
27
27
  end
@@ -290,6 +290,13 @@ module Google
290
290
  # @return [::String]
291
291
  # The fully qualified name of the method, for which the options below apply.
292
292
  # This is used to find the method to apply the options.
293
+ #
294
+ # Example:
295
+ #
296
+ # publishing:
297
+ # method_settings:
298
+ # - selector: google.storage.control.v2.StorageControl.CreateFolder
299
+ # # method settings for CreateFolder...
293
300
  # @!attribute [rw] long_running
294
301
  # @return [::Google::Api::MethodSettings::LongRunning]
295
302
  # Describes settings to use for long-running operations when generating
@@ -298,17 +305,14 @@ module Google
298
305
  #
299
306
  # Example of a YAML configuration::
300
307
  #
301
- # publishing:
302
- # method_settings:
308
+ # publishing:
309
+ # method_settings:
303
310
  # - selector: google.cloud.speech.v2.Speech.BatchRecognize
304
311
  # long_running:
305
- # initial_poll_delay:
306
- # seconds: 60 # 1 minute
312
+ # initial_poll_delay: 60s # 1 minute
307
313
  # poll_delay_multiplier: 1.5
308
- # max_poll_delay:
309
- # seconds: 360 # 6 minutes
310
- # total_poll_timeout:
311
- # seconds: 54000 # 90 minutes
314
+ # max_poll_delay: 360s # 6 minutes
315
+ # total_poll_timeout: 54000s # 90 minutes
312
316
  # @!attribute [rw] auto_populated_fields
313
317
  # @return [::Array<::String>]
314
318
  # List of top-level fields of the request message, that should be
@@ -317,8 +321,8 @@ module Google
317
321
  #
318
322
  # Example of a YAML configuration:
319
323
  #
320
- # publishing:
321
- # method_settings:
324
+ # publishing:
325
+ # method_settings:
322
326
  # - selector: google.example.v1.ExampleService.CreateExample
323
327
  # auto_populated_fields:
324
328
  # - request_id
@@ -25,6 +25,12 @@ module Google
25
25
  # The standard format of a field value. This does not explicitly configure
26
26
  # any API consumer, just documents the API's format for the field it is
27
27
  # applied to.
28
+ # @!attribute [rw] referenced_types
29
+ # @return [::Array<::Google::Api::TypeReference>]
30
+ # The type(s) that the annotated, generic field may represent.
31
+ #
32
+ # Currently, this must only be used on fields of type `google.protobuf.Any`.
33
+ # Supporting other generic types may be considered in the future.
28
34
  class FieldInfo
29
35
  include ::Google::Protobuf::MessageExts
30
36
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -61,5 +67,22 @@ module Google
61
67
  IPV4_OR_IPV6 = 4
62
68
  end
63
69
  end
70
+
71
+ # A reference to a message type, for use in {::Google::Api::FieldInfo FieldInfo}.
72
+ # @!attribute [rw] type_name
73
+ # @return [::String]
74
+ # The name of the type that the annotated, generic field may represent.
75
+ # If the type is in the same protobuf package, the value can be the simple
76
+ # message name e.g., `"MyMessage"`. Otherwise, the value must be the
77
+ # fully-qualified message name e.g., `"google.library.v1.Book"`.
78
+ #
79
+ # If the type(s) are unknown to the service (e.g. the field accepts generic
80
+ # user input), use the wildcard `"*"` to denote this behavior.
81
+ #
82
+ # See [AIP-202](https://google.aip.dev/202#type-references) for more details.
83
+ class TypeReference
84
+ include ::Google::Protobuf::MessageExts
85
+ extend ::Google::Protobuf::MessageExts::ClassMethods
86
+ end
64
87
  end
65
88
  end
@@ -124,8 +124,13 @@ module Google
124
124
  # @return [::String]
125
125
  # The plural name used in the resource name and permission names, such as
126
126
  # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
- # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
128
- # concept of the `plural` field in k8s CRD spec
127
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
128
+ # to this is for Nested Collections that have stuttering names, as defined
129
+ # in [AIP-122](https://google.aip.dev/122#nested-collections), where the
130
+ # collection ID in the resource name pattern does not necessarily directly
131
+ # match the `plural` value.
132
+ #
133
+ # It is the same concept of the `plural` field in k8s CRD spec
129
134
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
130
135
  #
131
136
  # Note: The plural form is required even for singleton resources. See
@@ -376,9 +376,7 @@ module Google
376
376
  # The following image values are supported for a boot disk:
377
377
  #
378
378
  # * `batch-debian`: use Batch Debian images.
379
- # * `batch-centos`: use Batch CentOS images.
380
379
  # * `batch-cos`: use Batch Container-Optimized images.
381
- # * `batch-hpc-centos`: use Batch HPC CentOS images.
382
380
  # * `batch-hpc-rocky`: use Batch HPC Rocky Linux images.
383
381
  # @!attribute [rw] snapshot
384
382
  # @return [::String]
@@ -74,7 +74,7 @@ module Google
74
74
  extend ::Google::Protobuf::MessageExts::ClassMethods
75
75
  end
76
76
 
77
- # Status event
77
+ # Status event.
78
78
  # @!attribute [rw] type
79
79
  # @return [::String]
80
80
  # Type of the event.
@@ -86,10 +86,13 @@ module Google
86
86
  # The time this event occurred.
87
87
  # @!attribute [rw] task_execution
88
88
  # @return [::Google::Cloud::Batch::V1::TaskExecution]
89
- # Task Execution
89
+ # Task Execution.
90
+ # This field is only defined for task-level status events where the task
91
+ # fails.
90
92
  # @!attribute [rw] task_state
91
93
  # @return [::Google::Cloud::Batch::V1::TaskStatus::State]
92
- # Task State
94
+ # Task State.
95
+ # This field is only defined for task-level status events.
93
96
  class StatusEvent
94
97
  include ::Google::Protobuf::MessageExts
95
98
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -115,10 +118,10 @@ module Google
115
118
  extend ::Google::Protobuf::MessageExts::ClassMethods
116
119
  end
117
120
 
118
- # Status of a task
121
+ # Status of a task.
119
122
  # @!attribute [rw] state
120
123
  # @return [::Google::Cloud::Batch::V1::TaskStatus::State]
121
- # Task state
124
+ # Task state.
122
125
  # @!attribute [rw] status_events
123
126
  # @return [::Array<::Google::Cloud::Batch::V1::StatusEvent>]
124
127
  # Detailed info about why the state is reached.
@@ -170,13 +173,24 @@ module Google
170
173
  # provided the index of the runnable will be used for outputs.
171
174
  # @!attribute [rw] ignore_exit_status
172
175
  # @return [::Boolean]
173
- # Normally, a non-zero exit status causes the Task to fail. This flag allows
174
- # execution of other Runnables to continue instead.
176
+ # Normally, a runnable that returns a non-zero exit status fails and causes
177
+ # the task to fail. However, you can set this field to `true` to allow the
178
+ # task to continue executing its other runnables even if this runnable
179
+ # fails.
175
180
  # @!attribute [rw] background
176
181
  # @return [::Boolean]
177
- # This flag allows a Runnable to continue running in the background while the
178
- # Task executes subsequent Runnables. This is useful to provide services to
179
- # other Runnables (or to provide debugging support tools like SSH servers).
182
+ # Normally, a runnable that doesn't exit causes its task to fail. However,
183
+ # you can set this field to `true` to configure a background runnable.
184
+ # Background runnables are allowed continue running in the background while
185
+ # the task executes subsequent runnables. For example, background runnables
186
+ # are useful for providing services to other runnables or providing
187
+ # debugging-support tools like SSH servers.
188
+ #
189
+ # Specifically, background runnables are killed automatically (if they have
190
+ # not already exited) a short time after all foreground runnables have
191
+ # completed. Even though this is likely to result in a non-zero exit status
192
+ # for the background runnable, these automatic kills are not treated as task
193
+ # failures.
180
194
  # @!attribute [rw] always_run
181
195
  # @return [::Boolean]
182
196
  # By default, after a Runnable fails, no further Runnable are executed. This
@@ -204,32 +218,36 @@ module Google
204
218
  # Container runnable.
205
219
  # @!attribute [rw] image_uri
206
220
  # @return [::String]
207
- # The URI to pull the container image from.
221
+ # Required. The URI to pull the container image from.
208
222
  # @!attribute [rw] commands
209
223
  # @return [::Array<::String>]
210
- # Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
211
- # (either in the container image or with the entrypoint field below) then
212
- # commands are appended as arguments to the ENTRYPOINT.
224
+ # Required for some container images. Overrides the `CMD` specified in the
225
+ # container. If there is an `ENTRYPOINT` (either in the container image or
226
+ # with the `entrypoint` field below) then these commands are appended as
227
+ # arguments to the `ENTRYPOINT`.
213
228
  # @!attribute [rw] entrypoint
214
229
  # @return [::String]
215
- # Overrides the `ENTRYPOINT` specified in the container.
230
+ # Required for some container images. Overrides the `ENTRYPOINT` specified
231
+ # in the container.
216
232
  # @!attribute [rw] volumes
217
233
  # @return [::Array<::String>]
218
234
  # Volumes to mount (bind mount) from the host machine files or directories
219
- # into the container, formatted to match docker run's --volume option,
220
- # e.g. /foo:/bar, or /foo:/bar:ro
235
+ # into the container, formatted to match `--volume` option for the
236
+ # `docker run` command&mdash;for example, `/foo:/bar` or `/foo:/bar:ro`.
221
237
  #
222
238
  # If the `TaskSpec.Volumes` field is specified but this field is not, Batch
223
239
  # will mount each volume from the host machine to the container with the
224
240
  # same mount path by default. In this case, the default mount option for
225
- # containers will be read-only (ro) for existing persistent disks and
226
- # read-write (rw) for other volume types, regardless of the original mount
227
- # options specified in `TaskSpec.Volumes`. If you need different mount
228
- # settings, you can explicitly configure them in this field.
241
+ # containers will be read-only (`ro`) for existing persistent disks and
242
+ # read-write (`rw`) for other volume types, regardless of the original
243
+ # mount options specified in `TaskSpec.Volumes`. If you need different
244
+ # mount settings, you can explicitly configure them in this field.
229
245
  # @!attribute [rw] options
230
246
  # @return [::String]
231
- # Arbitrary additional options to include in the "docker run" command when
232
- # running this container, e.g. "--network host".
247
+ # Required for some container images. Arbitrary additional options to
248
+ # include in the `docker run` command when running this container&mdash;for
249
+ # example, `--network host`. For the `--volume` option, use the `volumes`
250
+ # field for the container.
233
251
  # @!attribute [rw] block_external_network
234
252
  # @return [::Boolean]
235
253
  # If set to true, external network access to and from container will be
@@ -298,30 +316,33 @@ module Google
298
316
  # Script runnable.
299
317
  # @!attribute [rw] path
300
318
  # @return [::String]
301
- # Script file path on the host VM.
319
+ # The path to a script file that is accessible from the host VM(s).
302
320
  #
303
- # To specify an interpreter, please add a `#!<interpreter>`(also known as
304
- # [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
305
- # first line of the file.(For example, to execute the script using bash,
306
- # `#!/bin/bash` should be the first line of the file. To execute the
307
- # script using`Python3`, `#!/usr/bin/env python3` should be the first
308
- # line of the file.) Otherwise, the file will by default be executed by
309
- # `/bin/sh`.
321
+ # Unless the script file supports the default `#!/bin/sh` shell
322
+ # interpreter, you must specify an interpreter by including a
323
+ # [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) as the
324
+ # first line of the file. For example, to execute the script using bash,
325
+ # include `#!/bin/bash` as the first line of the file. Alternatively,
326
+ # to execute the script using Python3, include `#!/usr/bin/env python3`
327
+ # as the first line of the file.
310
328
  # @!attribute [rw] text
311
329
  # @return [::String]
312
- # Shell script text.
330
+ # The text for a script.
313
331
  #
314
- # To specify an interpreter, please add a `#!<interpreter>\n` at the
315
- # beginning of the text.(For example, to execute the script using bash,
316
- # `#!/bin/bash\n` should be added. To execute the script using`Python3`,
317
- # `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
318
- # by default be executed by `/bin/sh`.
332
+ # Unless the script text supports the default `#!/bin/sh` shell
333
+ # interpreter, you must specify an interpreter by including a
334
+ # [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) at the
335
+ # beginning of the text. For example, to execute the script using bash,
336
+ # include `#!/bin/bash\n` at the beginning of the text. Alternatively,
337
+ # to execute the script using Python3, include `#!/usr/bin/env python3\n`
338
+ # at the beginning of the text.
319
339
  class Script
320
340
  include ::Google::Protobuf::MessageExts
321
341
  extend ::Google::Protobuf::MessageExts::ClassMethods
322
342
  end
323
343
 
324
- # Barrier runnable blocks until all tasks in a taskgroup reach it.
344
+ # A barrier runnable automatically blocks the execution of subsequent
345
+ # runnables until all the tasks in the task group reach the barrier.
325
346
  # @!attribute [rw] name
326
347
  # @return [::String]
327
348
  # Barriers are identified by their index in runnable list.
@@ -344,16 +365,16 @@ module Google
344
365
  # Spec of a task
345
366
  # @!attribute [rw] runnables
346
367
  # @return [::Array<::Google::Cloud::Batch::V1::Runnable>]
347
- # The sequence of scripts or containers to run for this Task. Each Task using
348
- # this TaskSpec executes its list of runnables in order. The Task succeeds if
349
- # all of its runnables either exit with a zero status or any that exit with a
350
- # non-zero status have the ignore_exit_status flag.
368
+ # Required. The sequence of one or more runnables (executable scripts,
369
+ # executable containers, and/or barriers) for each task in this task group to
370
+ # run. Each task runs this list of runnables in order. For a task to succeed,
371
+ # all of its script and container runnables each must meet at least one of
372
+ # the following conditions:
351
373
  #
352
- # Background runnables are killed automatically (if they have not already
353
- # exited) a short time after all foreground runnables have completed. Even
354
- # though this is likely to result in a non-zero exit status for the
355
- # background runnable, these automatic kills are not treated as Task
356
- # failures.
374
+ # + The runnable exited with a zero status.
375
+ # + The runnable didn't finish, but you enabled its `background` subfield.
376
+ # + The runnable exited with a non-zero status, but you enabled its
377
+ # `ignore_exit_status` subfield.
357
378
  # @!attribute [rw] compute_resource
358
379
  # @return [::Google::Cloud::Batch::V1::ComputeResource]
359
380
  # ComputeResource requirements.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-batch-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.18.0
4
+ version: 0.18.2
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-06-27 00:00:00.000000000 Z
11
+ date: 2024-08-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common