google-cloud-assured_workloads 1.4.0 → 1.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 856f53a8504ad605a7d82acf6ddbba9d0e28fd31264f7f243f0f0f1ccf4dcd55
4
- data.tar.gz: 51c122f78ff158623ebf224093adc2cc7a0f0095002e192851d00a6f1ae33269
3
+ metadata.gz: edc899240943a2a684366884a3de02a06576d2194c779e258da5699a8c483f26
4
+ data.tar.gz: 7484d3f919870ac9e0c2750bbd34167229428a411f486eecac8d952288cf776f
5
5
  SHA512:
6
- metadata.gz: c7df74b4a87b60aa75f8f7702992e7306db52515247c5050865c76941e13530373625e994e07bf72a0c487ae05a17cec64924e4e7946938700109432cef18d4c
7
- data.tar.gz: a339167d3e8e3529a4df137ae3d2605a7f185c3857eef0df889485570b1d51ceba6408c2cd2cee6c14da990fda54870226bb6183c3c981bd18b5f88392dbdaee
6
+ metadata.gz: 01a3b39e043dad9f8e9f0e103105900741679fb8e86099697bf14d0e5d75383613c1e191532ba9705d44c141f062f306e07d233c988406d350727cd66f3e7309
7
+ data.tar.gz: 626221217b6d3c987d6a1f141c6addafc9fe7e0422cd1f0d39ae3e7c74160d49235c656453cb791e338a36ba580064075b263bdaca7fd4a2c06a7defc155d906
data/README.md CHANGED
@@ -35,9 +35,40 @@ In order to use this library, you first need to go through the following steps:
35
35
  1. [Enable the API.](https://console.cloud.google.com/apis/library/assuredworkloads.googleapis.com)
36
36
  1. {file:AUTHENTICATION.md Set up authentication.}
37
37
 
38
+ ## Debug Logging
39
+
40
+ This library comes with opt-in Debug Logging that can help you troubleshoot
41
+ your application's integration with the API. When logging is activated, key
42
+ events such as requests and responses, along with data payloads and metadata
43
+ such as headers and client configuration, are logged to the standard error
44
+ stream.
45
+
46
+ **WARNING:** Client Library Debug Logging includes your data payloads in
47
+ plaintext, which could include sensitive data such as PII for yourself or your
48
+ customers, private keys, or other security data that could be compromising if
49
+ leaked. Always practice good data hygiene with your application logs, and follow
50
+ the principle of least access. Google also recommends that Client Library Debug
51
+ Logging be enabled only temporarily during active debugging, and not used
52
+ permanently in production.
53
+
54
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
55
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
56
+ list of client library gem names. This will select the default logging behavior,
57
+ which writes logs to the standard error stream. On a local workstation, this may
58
+ result in logs appearing on the console. When running on a Google Cloud hosting
59
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
60
+ results in logs appearing alongside your application logs in the
61
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
62
+
63
+ Debug logging also requires that the versioned clients for this service be
64
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
65
+ working, try updating the versioned clients in your bundle or installed gems:
66
+ [google-cloud-assured_workloads-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-assured_workloads-v1/latest),
67
+ [google-cloud-assured_workloads-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-assured_workloads-v1beta1/latest).
68
+
38
69
  ## Supported Ruby Versions
39
70
 
40
- This library is supported on Ruby 2.7+.
71
+ This library is supported on Ruby 3.0+.
41
72
 
42
73
  Google provides official support for Ruby versions that are actively supported
43
74
  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 AssuredWorkloads
23
- VERSION = "1.4.0"
23
+ VERSION = "1.5.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 AssuredWorkloadsService service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::AssuredWorkloads.assured_workloads_service_available?}.
65
+ #
61
66
  # ## About AssuredWorkloadsService
62
67
  #
63
68
  # Service to manage AssuredWorkloads.
@@ -79,6 +84,37 @@ module Google
79
84
  service_module.const_get(:Client).new(&block)
80
85
  end
81
86
 
87
+ ##
88
+ # Determines whether the AssuredWorkloadsService service is supported by the current client.
89
+ # If true, you can retrieve a client object by calling {Google::Cloud::AssuredWorkloads.assured_workloads_service}.
90
+ # If false, that method will raise an exception. This could happen if the given
91
+ # API version does not exist or does not support the AssuredWorkloadsService service,
92
+ # or if the versioned client gem needs an update to support the AssuredWorkloadsService service.
93
+ #
94
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
95
+ # Defaults to `:v1`.
96
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
97
+ # @return [boolean] Whether the service is available.
98
+ #
99
+ def self.assured_workloads_service_available? version: :v1, transport: :grpc
100
+ require "google/cloud/assured_workloads/#{version.to_s.downcase}"
101
+ package_name = Google::Cloud::AssuredWorkloads
102
+ .constants
103
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
104
+ .first
105
+ return false unless package_name
106
+ service_module = Google::Cloud::AssuredWorkloads.const_get package_name
107
+ return false unless service_module.const_defined? :AssuredWorkloadsService
108
+ service_module = service_module.const_get :AssuredWorkloadsService
109
+ if transport == :rest
110
+ return false unless service_module.const_defined? :Rest
111
+ service_module = service_module.const_get :Rest
112
+ end
113
+ service_module.const_defined? :Client
114
+ rescue ::LoadError
115
+ false
116
+ end
117
+
82
118
  ##
83
119
  # Configure the google-cloud-assured_workloads library.
84
120
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-assured_workloads
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.0
4
+ version: 1.5.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-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-cloud-assured_workloads-v1
@@ -82,7 +81,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
82
81
  licenses:
83
82
  - Apache-2.0
84
83
  metadata: {}
85
- post_install_message:
86
84
  rdoc_options: []
87
85
  require_paths:
88
86
  - lib
@@ -90,15 +88,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
90
88
  requirements:
91
89
  - - ">="
92
90
  - !ruby/object:Gem::Version
93
- version: '2.7'
91
+ version: '3.0'
94
92
  required_rubygems_version: !ruby/object:Gem::Requirement
95
93
  requirements:
96
94
  - - ">="
97
95
  - !ruby/object:Gem::Version
98
96
  version: '0'
99
97
  requirements: []
100
- rubygems_version: 3.5.6
101
- signing_key:
98
+ rubygems_version: 3.6.2
102
99
  specification_version: 4
103
100
  summary: API Client library for the Assured Workloads for Government API
104
101
  test_files: []