google-cloud-service_control 1.4.1 → 1.5.1

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: cf51ad44d92bee3ef479fbc6e34fcd1abf61a02c3b7819a3c198f4d0f0ec52dd
4
- data.tar.gz: 9821328a7be95822551d250e476a3a28df01e2e09b74b85ef019267e938e0a6a
3
+ metadata.gz: d92f8280f8b4480d451a5ef6e8ce59c6ed2520258ba276afd615d6033ab2b52c
4
+ data.tar.gz: e7c785e218621ca91437bbc4821f4777f5571770485106a2e56ea9cd047d678c
5
5
  SHA512:
6
- metadata.gz: bf1622d912c6fc043722f70e2f9acb5db26af4fa1881b6d4719a7155917dd5f083540bf247b3ebde20d0a92c6b272c37ef25283fbb26a227e0c42e48014e775c
7
- data.tar.gz: 9ef9d7804b19c57cde967ad2617503e5834e433b4a4b537751569147337e9a5b9a3013637a6d2c88c5a884fe138ef32615c23379778520b2581241c9571e8d5d
6
+ metadata.gz: 4d1500521933a127af413ad5cb48d2773d6297b77e2e25bcd9c30a795c9f9cc35f661998e5ee04ea71d6bb54ac6cd9abfe8c4015c6d4b5688f7d2c7b3843b691
7
+ data.tar.gz: daac7bc03ae14dbb9ad35179947cd4d24ff5ff3b0c7428fbe9e2cd09141edb5bc8eb7c24a0dcb86cbc7216cd544f33b004ff15c7e8034e9df62c92315be60746
data/README.md CHANGED
@@ -7,7 +7,7 @@ The Service Control API provides control plane functionality to managed services
7
7
  Actual client classes for the various versions of this API are defined in
8
8
  _versioned_ client gems, with names of the form `google-cloud-service_control-v*`.
9
9
  The gem `google-cloud-service_control` is the main client library that brings the
10
- verisoned gems in as dependencies, and provides high-level methods for
10
+ versioned gems in as dependencies, and provides high-level methods for
11
11
  constructing clients. More information on versioned clients can be found below
12
12
  in the section titled *Which client should I use?*.
13
13
 
@@ -34,9 +34,39 @@ In order to use this library, you first need to go through the following steps:
34
34
  1. [Enable the API.](https://console.cloud.google.com/apis/library/servicecontrol.googleapis.com)
35
35
  1. {file:AUTHENTICATION.md Set up authentication.}
36
36
 
37
+ ## Debug Logging
38
+
39
+ This library comes with opt-in Debug Logging that can help you troubleshoot
40
+ your application's integration with the API. When logging is activated, key
41
+ events such as requests and responses, along with data payloads and metadata
42
+ such as headers and client configuration, are logged to the standard error
43
+ stream.
44
+
45
+ **WARNING:** Client Library Debug Logging includes your data payloads in
46
+ plaintext, which could include sensitive data such as PII for yourself or your
47
+ customers, private keys, or other security data that could be compromising if
48
+ leaked. Always practice good data hygiene with your application logs, and follow
49
+ the principle of least access. Google also recommends that Client Library Debug
50
+ Logging be enabled only temporarily during active debugging, and not used
51
+ permanently in production.
52
+
53
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
54
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
55
+ list of client library gem names. This will select the default logging behavior,
56
+ which writes logs to the standard error stream. On a local workstation, this may
57
+ result in logs appearing on the console. When running on a Google Cloud hosting
58
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
59
+ results in logs appearing alongside your application logs in the
60
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
61
+
62
+ Debug logging also requires that the versioned clients for this service be
63
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
64
+ working, try updating the versioned clients in your bundle or installed gems:
65
+ [google-cloud-service_control-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-service_control-v1/latest).
66
+
37
67
  ## Supported Ruby Versions
38
68
 
39
- This library is supported on Ruby 2.7+.
69
+ This library is supported on Ruby 3.0+.
40
70
 
41
71
  Google provides official support for Ruby versions that are actively supported
42
72
  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 ServiceControl
23
- VERSION = "1.4.1"
23
+ VERSION = "1.5.1"
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 QuotaController service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::ServiceControl.quota_controller_available?}.
65
+ #
61
66
  # ## About QuotaController
62
67
  #
63
68
  # [Google Quota Control API](/service-control/overview)
@@ -82,6 +87,37 @@ module Google
82
87
  service_module.const_get(:Client).new(&block)
83
88
  end
84
89
 
90
+ ##
91
+ # Determines whether the QuotaController service is supported by the current client.
92
+ # If true, you can retrieve a client object by calling {Google::Cloud::ServiceControl.quota_controller}.
93
+ # If false, that method will raise an exception. This could happen if the given
94
+ # API version does not exist or does not support the QuotaController service,
95
+ # or if the versioned client gem needs an update to support the QuotaController service.
96
+ #
97
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
98
+ # Defaults to `:v1`.
99
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
100
+ # @return [boolean] Whether the service is available.
101
+ #
102
+ def self.quota_controller_available? version: :v1, transport: :grpc
103
+ require "google/cloud/service_control/#{version.to_s.downcase}"
104
+ package_name = Google::Cloud::ServiceControl
105
+ .constants
106
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
107
+ .first
108
+ return false unless package_name
109
+ service_module = Google::Cloud::ServiceControl.const_get package_name
110
+ return false unless service_module.const_defined? :QuotaController
111
+ service_module = service_module.const_get :QuotaController
112
+ if transport == :rest
113
+ return false unless service_module.const_defined? :Rest
114
+ service_module = service_module.const_get :Rest
115
+ end
116
+ service_module.const_defined? :Client
117
+ rescue ::LoadError
118
+ false
119
+ end
120
+
85
121
  ##
86
122
  # Create a new client object for ServiceController.
87
123
  #
@@ -95,6 +131,11 @@ module Google
95
131
  # You can also specify a different transport by passing `:rest` or `:grpc` in
96
132
  # the `transport` parameter.
97
133
  #
134
+ # Raises an exception if the currently installed versioned client gem for the
135
+ # given API version does not support the given transport of the ServiceController service.
136
+ # You can determine whether the method will succeed by calling
137
+ # {Google::Cloud::ServiceControl.service_controller_available?}.
138
+ #
98
139
  # ## About ServiceController
99
140
  #
100
141
  # [Google Service Control API](/service-control/overview)
@@ -119,6 +160,37 @@ module Google
119
160
  service_module.const_get(:Client).new(&block)
120
161
  end
121
162
 
163
+ ##
164
+ # Determines whether the ServiceController service is supported by the current client.
165
+ # If true, you can retrieve a client object by calling {Google::Cloud::ServiceControl.service_controller}.
166
+ # If false, that method will raise an exception. This could happen if the given
167
+ # API version does not exist or does not support the ServiceController service,
168
+ # or if the versioned client gem needs an update to support the ServiceController service.
169
+ #
170
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
171
+ # Defaults to `:v1`.
172
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
173
+ # @return [boolean] Whether the service is available.
174
+ #
175
+ def self.service_controller_available? version: :v1, transport: :grpc
176
+ require "google/cloud/service_control/#{version.to_s.downcase}"
177
+ package_name = Google::Cloud::ServiceControl
178
+ .constants
179
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
180
+ .first
181
+ return false unless package_name
182
+ service_module = Google::Cloud::ServiceControl.const_get package_name
183
+ return false unless service_module.const_defined? :ServiceController
184
+ service_module = service_module.const_get :ServiceController
185
+ if transport == :rest
186
+ return false unless service_module.const_defined? :Rest
187
+ service_module = service_module.const_get :Rest
188
+ end
189
+ service_module.const_defined? :Client
190
+ rescue ::LoadError
191
+ false
192
+ end
193
+
122
194
  ##
123
195
  # Configure the google-cloud-service_control library.
124
196
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-service_control
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.1
4
+ version: 1.5.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-08-08 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-cloud-core
@@ -62,7 +61,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
62
61
  licenses:
63
62
  - Apache-2.0
64
63
  metadata: {}
65
- post_install_message:
66
64
  rdoc_options: []
67
65
  require_paths:
68
66
  - lib
@@ -70,15 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
70
68
  requirements:
71
69
  - - ">="
72
70
  - !ruby/object:Gem::Version
73
- version: '2.7'
71
+ version: '3.0'
74
72
  required_rubygems_version: !ruby/object:Gem::Requirement
75
73
  requirements:
76
74
  - - ">="
77
75
  - !ruby/object:Gem::Version
78
76
  version: '0'
79
77
  requirements: []
80
- rubygems_version: 3.5.6
81
- signing_key:
78
+ rubygems_version: 3.6.8
82
79
  specification_version: 4
83
80
  summary: API Client library for the Service Control API API
84
81
  test_files: []