google-cloud-batch-v1 0.19.1 → 0.20.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.
@@ -44,16 +44,18 @@ module Google
44
44
  # Compute resource allocation for all TaskGroups in the Job.
45
45
  # @!attribute [rw] labels
46
46
  # @return [::Google::Protobuf::Map{::String => ::String}]
47
- # Labels for the Job. Labels could be user provided or system generated.
48
- # For example,
49
- # "labels": {
50
- # "department": "finance",
51
- # "environment": "test"
52
- # }
53
- # You can assign up to 64 labels. [Google Compute Engine label
54
- # restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
55
- # apply.
56
- # Label names that start with "goog-" or "google-" are reserved.
47
+ # Custom labels to apply to the job and any Cloud Logging
48
+ # [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)
49
+ # that it generates.
50
+ #
51
+ # Use labels to group and describe the resources they are applied to. Batch
52
+ # automatically applies predefined labels and supports multiple `labels`
53
+ # fields for each job, which each let you apply custom labels to various
54
+ # resources. Label names that start with "goog-" or "google-" are
55
+ # reserved for predefined labels. For more information about labels with
56
+ # Batch, see
57
+ # [Organize resources using
58
+ # labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
57
59
  # @!attribute [r] status
58
60
  # @return [::Google::Cloud::Batch::V1::JobStatus]
59
61
  # Output only. Job status. It is read only for users.
@@ -83,20 +85,27 @@ module Google
83
85
  end
84
86
  end
85
87
 
86
- # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be
87
- # preserved.
88
+ # LogsPolicy describes if and how a job's logs are preserved. Logs include
89
+ # information that is automatically written by the Batch service agent and any
90
+ # information that you configured the job's runnables to write to the `stdout`
91
+ # or `stderr` streams.
88
92
  # @!attribute [rw] destination
89
93
  # @return [::Google::Cloud::Batch::V1::LogsPolicy::Destination]
90
- # Where logs should be saved.
94
+ # If and where logs should be saved.
91
95
  # @!attribute [rw] logs_path
92
96
  # @return [::String]
93
- # The path to which logs are saved when the destination = PATH. This can be a
94
- # local file path on the VM, or under the mount point of a Persistent Disk or
95
- # Filestore, or a Cloud Storage path.
97
+ # When `destination` is set to `PATH`, you must set this field to the path
98
+ # where you want logs to be saved. This path can point to a local directory
99
+ # on the VM or (if congifured) a directory under the mount path of any
100
+ # Cloud Storage bucket, network file system (NFS), or writable persistent
101
+ # disk that is mounted to the job. For example, if the job has a bucket with
102
+ # `mountPath` set to `/mnt/disks/my-bucket`, you can write logs to the
103
+ # root directory of the `remotePath` of that bucket by setting this field to
104
+ # `/mnt/disks/my-bucket/`.
96
105
  # @!attribute [rw] cloud_logging_option
97
106
  # @return [::Google::Cloud::Batch::V1::LogsPolicy::CloudLoggingOption]
98
- # Optional. Additional settings for Cloud Logging. It will only take effect
99
- # when the destination of `LogsPolicy` is set to `CLOUD_LOGGING`.
107
+ # Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally
108
+ # set this field to configure additional settings for Cloud Logging.
100
109
  class LogsPolicy
101
110
  include ::Google::Protobuf::MessageExts
102
111
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -105,7 +114,7 @@ module Google
105
114
  # generated by Batch job.
106
115
  # @!attribute [rw] use_generic_task_monitored_resource
107
116
  # @return [::Boolean]
108
- # Optional. Set this flag to true to change the [monitored resource
117
+ # Optional. Set this field to `true` to change the [monitored resource
109
118
  # type](https://cloud.google.com/monitoring/api/resources) for
110
119
  # Cloud Logging logs generated by this Batch job from
111
120
  # the
@@ -120,13 +129,14 @@ module Google
120
129
 
121
130
  # The destination (if any) for logs.
122
131
  module Destination
123
- # Logs are not preserved.
132
+ # (Default) Logs are not preserved.
124
133
  DESTINATION_UNSPECIFIED = 0
125
134
 
126
- # Logs are streamed to Cloud Logging.
135
+ # Logs are streamed to Cloud Logging. Optionally, you can configure
136
+ # additional settings in the `cloudLoggingOption` field.
127
137
  CLOUD_LOGGING = 1
128
138
 
129
- # Logs are saved to a file path.
139
+ # Logs are saved to the file path specified in the `logsPath` field.
130
140
  PATH = 2
131
141
  end
132
142
  end
@@ -309,13 +319,17 @@ module Google
309
319
  # default cloud-platform scope. (list of strings)
310
320
  # @!attribute [rw] labels
311
321
  # @return [::Google::Protobuf::Map{::String => ::String}]
312
- # Labels applied to all VM instances and other resources
313
- # created by AllocationPolicy.
314
- # Labels could be user provided or system generated.
315
- # You can assign up to 64 labels. [Google Compute Engine label
316
- # restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
317
- # apply.
318
- # Label names that start with "goog-" or "google-" are reserved.
322
+ # Custom labels to apply to the job and all the Compute Engine resources
323
+ # that both are created by this allocation policy and support labels.
324
+ #
325
+ # Use labels to group and describe the resources they are applied to. Batch
326
+ # automatically applies predefined labels and supports multiple `labels`
327
+ # fields for each job, which each let you apply custom labels to various
328
+ # resources. Label names that start with "goog-" or "google-" are
329
+ # reserved for predefined labels. For more information about labels with
330
+ # Batch, see
331
+ # [Organize resources using
332
+ # labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
319
333
  # @!attribute [rw] network
320
334
  # @return [::Google::Cloud::Batch::V1::AllocationPolicy::NetworkPolicy]
321
335
  # The network policy.
@@ -497,8 +511,10 @@ module Google
497
511
  # storage and accessing.
498
512
  # @!attribute [rw] reservation
499
513
  # @return [::String]
500
- # Optional. If specified, VMs will consume only the specified reservation.
501
- # If not specified (default), VMs will consume any applicable reservation.
514
+ # Optional. If not specified (default), VMs will consume any applicable
515
+ # reservation. If "NO_RESERVATION" is specified, VMs will not consume any
516
+ # reservation. Otherwise, if specified, VMs will consume only the specified
517
+ # reservation.
502
518
  class InstancePolicy
503
519
  include ::Google::Protobuf::MessageExts
504
520
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -517,7 +533,8 @@ module Google
517
533
  # Named the field as 'instance_template' instead of 'template' to avoid
518
534
  # C++ keyword conflict.
519
535
  #
520
- # Batch only supports global instance templates.
536
+ # Batch only supports global instance templates from the same project as
537
+ # the job.
521
538
  # You can specify the global instance template as a full or partial URL.
522
539
  # @!attribute [rw] install_gpu_drivers
523
540
  # @return [::Boolean]
@@ -42,7 +42,7 @@ module Google
42
42
  # The error result of the operation in case of failure or cancellation.
43
43
  # @!attribute [rw] response
44
44
  # @return [::Google::Protobuf::Any]
45
- # The normal response of the operation in case of success. If the original
45
+ # The normal, successful response of the operation. If the original
46
46
  # method returns no data on success, such as `Delete`, the response is
47
47
  # `google.protobuf.Empty`. If the original method is standard
48
48
  # `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -55,7 +55,8 @@ module Google
55
55
  extend ::Google::Protobuf::MessageExts::ClassMethods
56
56
  end
57
57
 
58
- # The request message for Operations.GetOperation.
58
+ # The request message for
59
+ # Operations.GetOperation.
59
60
  # @!attribute [rw] name
60
61
  # @return [::String]
61
62
  # The name of the operation resource.
@@ -64,7 +65,8 @@ module Google
64
65
  extend ::Google::Protobuf::MessageExts::ClassMethods
65
66
  end
66
67
 
67
- # The request message for Operations.ListOperations.
68
+ # The request message for
69
+ # Operations.ListOperations.
68
70
  # @!attribute [rw] name
69
71
  # @return [::String]
70
72
  # The name of the operation's parent resource.
@@ -82,7 +84,8 @@ module Google
82
84
  extend ::Google::Protobuf::MessageExts::ClassMethods
83
85
  end
84
86
 
85
- # The response message for Operations.ListOperations.
87
+ # The response message for
88
+ # Operations.ListOperations.
86
89
  # @!attribute [rw] operations
87
90
  # @return [::Array<::Google::Longrunning::Operation>]
88
91
  # A list of operations that matches the specified filter in the request.
@@ -94,7 +97,8 @@ module Google
94
97
  extend ::Google::Protobuf::MessageExts::ClassMethods
95
98
  end
96
99
 
97
- # The request message for Operations.CancelOperation.
100
+ # The request message for
101
+ # Operations.CancelOperation.
98
102
  # @!attribute [rw] name
99
103
  # @return [::String]
100
104
  # The name of the operation resource to be cancelled.
@@ -103,7 +107,8 @@ module Google
103
107
  extend ::Google::Protobuf::MessageExts::ClassMethods
104
108
  end
105
109
 
106
- # The request message for Operations.DeleteOperation.
110
+ # The request message for
111
+ # Operations.DeleteOperation.
107
112
  # @!attribute [rw] name
108
113
  # @return [::String]
109
114
  # The name of the operation resource to be deleted.
@@ -112,7 +117,8 @@ module Google
112
117
  extend ::Google::Protobuf::MessageExts::ClassMethods
113
118
  end
114
119
 
115
- # The request message for Operations.WaitOperation.
120
+ # The request message for
121
+ # Operations.WaitOperation.
116
122
  # @!attribute [rw] name
117
123
  # @return [::String]
118
124
  # The name of the operation resource to wait on.
@@ -130,13 +136,12 @@ module Google
130
136
  #
131
137
  # Example:
132
138
  #
133
- # rpc LongRunningRecognize(LongRunningRecognizeRequest)
134
- # returns (google.longrunning.Operation) {
135
- # option (google.longrunning.operation_info) = {
136
- # response_type: "LongRunningRecognizeResponse"
137
- # metadata_type: "LongRunningRecognizeMetadata"
138
- # };
139
- # }
139
+ # rpc Export(ExportRequest) returns (google.longrunning.Operation) {
140
+ # option (google.longrunning.operation_info) = {
141
+ # response_type: "ExportResponse"
142
+ # metadata_type: "ExportMetadata"
143
+ # };
144
+ # }
140
145
  # @!attribute [rw] response_type
141
146
  # @return [::String]
142
147
  # Required. The message name of the primary return type for this
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.19.1
4
+ version: 0.20.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-10-02 00:00:00.000000000 Z
11
+ date: 2024-12-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.21.1
19
+ version: 0.24.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.21.1
29
+ version: 0.24.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
162
162
  - !ruby/object:Gem::Version
163
163
  version: '0'
164
164
  requirements: []
165
- rubygems_version: 3.5.6
165
+ rubygems_version: 3.5.23
166
166
  signing_key:
167
167
  specification_version: 4
168
168
  summary: An API to manage the running of Batch resources on Google Cloud Platform.