google-cloud-batch 1.2.0 → 2.0.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: 8f1a3d702f9ad0bc80ad2165867876df66b8e0bc158f9885454606ca0af634fc
4
- data.tar.gz: 8a255807ccfa9c92c27d116a09a866bc47c8c0d588a68265472a15a5ac929079
3
+ metadata.gz: 5e3839423017d432abfadb6e3c28e8d9808418f314823446279c4be01a101b3f
4
+ data.tar.gz: ef64eb5e4a59069e967431911641506889a94f8504bb12c3d5c345fa2b5fd23c
5
5
  SHA512:
6
- metadata.gz: a88a4874772f734f22e86b75c06b92f01309eed54927fa200587ca90077ee8d3759d464ddd5a7ae0fb2944243fee4f7aad94bb3ff100da124126b4e4e18af63f
7
- data.tar.gz: 1ddd97746a16c68027ca7cfd02a87ea5b1c3df97faa3eaaf3278b3be6a3fe89baa9ada08645646c49fb65a2f63548ebc9db7e57840d3426bbccfe46abaf51e6a
6
+ metadata.gz: 589a6bc6844189ac88f2cdfebbc5ca3ca111ce9c75f0d3ebec218613d7fc2c34599ef57d8caaa05b9fd3704dc4a53fb12b1ef87bc92b27fae5b5dbdd0a16751e
7
+ data.tar.gz: e9aa3f982d8472ffeba2abe279a7180ed866099e0a3fabc40bf63810f3b59a8c2a3167796a54cb0487b609bc06d94d7186f50f2f07cc597510629ed359dd7c2e
data/README.md CHANGED
@@ -31,9 +31,39 @@ In order to use this library, you first need to go through the following steps:
31
31
  1. [Enable the API.](https://console.cloud.google.com/apis/library/batch.googleapis.com)
32
32
  1. {file:AUTHENTICATION.md Set up authentication.}
33
33
 
34
+ ## Debug Logging
35
+
36
+ This library comes with opt-in Debug Logging that can help you troubleshoot
37
+ your application's integration with the API. When logging is activated, key
38
+ events such as requests and responses, along with data payloads and metadata
39
+ such as headers and client configuration, are logged to the standard error
40
+ stream.
41
+
42
+ **WARNING:** Client Library Debug Logging includes your data payloads in
43
+ plaintext, which could include sensitive data such as PII for yourself or your
44
+ customers, private keys, or other security data that could be compromising if
45
+ leaked. Always practice good data hygiene with your application logs, and follow
46
+ the principle of least access. Google also recommends that Client Library Debug
47
+ Logging be enabled only temporarily during active debugging, and not used
48
+ permanently in production.
49
+
50
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
51
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
52
+ list of client library gem names. This will select the default logging behavior,
53
+ which writes logs to the standard error stream. On a local workstation, this may
54
+ result in logs appearing on the console. When running on a Google Cloud hosting
55
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
56
+ results in logs appearing alongside your application logs in the
57
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
58
+
59
+ Debug logging also requires that the versioned clients for this service be
60
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
61
+ working, try updating the versioned clients in your bundle or installed gems:
62
+ [google-cloud-batch-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-batch-v1/latest).
63
+
34
64
  ## Supported Ruby Versions
35
65
 
36
- This library is supported on Ruby 2.7+.
66
+ This library is supported on Ruby 3.0+.
37
67
 
38
68
  Google provides official support for Ruby versions that are actively supported
39
69
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module Batch
23
- VERSION = "1.2.0"
23
+ VERSION = "2.0.0"
24
24
  end
25
25
  end
26
26
  end
@@ -58,6 +58,11 @@ module Google
58
58
  # You can also specify a different transport by passing `:rest` or `:grpc` in
59
59
  # the `transport` parameter.
60
60
  #
61
+ # Raises an exception if the currently installed versioned client gem for the
62
+ # given API version does not support the given transport of the BatchService service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::Batch.batch_service_available?}.
65
+ #
61
66
  # ## About BatchService
62
67
  #
63
68
  # Google Batch Service.
@@ -81,6 +86,37 @@ module Google
81
86
  service_module.const_get(:Client).new(&block)
82
87
  end
83
88
 
89
+ ##
90
+ # Determines whether the BatchService service is supported by the current client.
91
+ # If true, you can retrieve a client object by calling {Google::Cloud::Batch.batch_service}.
92
+ # If false, that method will raise an exception. This could happen if the given
93
+ # API version does not exist or does not support the BatchService service,
94
+ # or if the versioned client gem needs an update to support the BatchService service.
95
+ #
96
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
97
+ # Defaults to `:v1`.
98
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
99
+ # @return [boolean] Whether the service is available.
100
+ #
101
+ def self.batch_service_available? version: :v1, transport: :grpc
102
+ require "google/cloud/batch/#{version.to_s.downcase}"
103
+ package_name = Google::Cloud::Batch
104
+ .constants
105
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
106
+ .first
107
+ return false unless package_name
108
+ service_module = Google::Cloud::Batch.const_get package_name
109
+ return false unless service_module.const_defined? :BatchService
110
+ service_module = service_module.const_get :BatchService
111
+ if transport == :rest
112
+ return false unless service_module.const_defined? :Rest
113
+ service_module = service_module.const_get :Rest
114
+ end
115
+ service_module.const_defined? :Client
116
+ rescue ::LoadError
117
+ false
118
+ end
119
+
84
120
  ##
85
121
  # Configure the google-cloud-batch library.
86
122
  #
metadata CHANGED
@@ -1,35 +1,28 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-batch
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.0
4
+ version: 2.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-02-26 00:00:00.000000000 Z
10
+ date: 2025-02-13 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-cloud-batch-v1
15
14
  requirement: !ruby/object:Gem::Requirement
16
15
  requirements:
17
- - - ">="
18
- - !ruby/object:Gem::Version
19
- version: '0.15'
20
- - - "<"
16
+ - - "~>"
21
17
  - !ruby/object:Gem::Version
22
- version: 2.a
18
+ version: '1.0'
23
19
  type: :runtime
24
20
  prerelease: false
25
21
  version_requirements: !ruby/object:Gem::Requirement
26
22
  requirements:
27
- - - ">="
28
- - !ruby/object:Gem::Version
29
- version: '0.15'
30
- - - "<"
23
+ - - "~>"
31
24
  - !ruby/object:Gem::Version
32
- version: 2.a
25
+ version: '1.0'
33
26
  - !ruby/object:Gem::Dependency
34
27
  name: google-cloud-core
35
28
  requirement: !ruby/object:Gem::Requirement
@@ -65,7 +58,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
65
58
  licenses:
66
59
  - Apache-2.0
67
60
  metadata: {}
68
- post_install_message:
69
61
  rdoc_options: []
70
62
  require_paths:
71
63
  - lib
@@ -73,15 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
73
65
  requirements:
74
66
  - - ">="
75
67
  - !ruby/object:Gem::Version
76
- version: '2.7'
68
+ version: '3.0'
77
69
  required_rubygems_version: !ruby/object:Gem::Requirement
78
70
  requirements:
79
71
  - - ">="
80
72
  - !ruby/object:Gem::Version
81
73
  version: '0'
82
74
  requirements: []
83
- rubygems_version: 3.5.6
84
- signing_key:
75
+ rubygems_version: 3.6.3
85
76
  specification_version: 4
86
77
  summary: API Client library for the Batch API
87
78
  test_files: []