google-cloud-org_policy 1.4.1 → 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: e6b976fcef5aa89c6099277d3617598c8336ca882d4211537596a726b9d5eac1
4
- data.tar.gz: dc3f85b2f5bb93ffc8969d8d76c9a7d839b77442e31901240a7ff68b3233c885
3
+ metadata.gz: 79d851d9de58e41ba00793ca284dc8d4cf7183c9191a3aae423aa85e5a57fea5
4
+ data.tar.gz: 17918c2455a26ce4db3c263ade868a6a970007cbec8347480ff51d7f88ec8ab1
5
5
  SHA512:
6
- metadata.gz: 138ba9b18a5b15190fb196a3269570c1deabc0b25bdfae39a64006cd2e1db10175dff709fe34c103afd9988f40abe943423845d33b5693d6e8d6afc316897fee
7
- data.tar.gz: a54798a8a6b30e210da574467d61f84b7803e295f92da2bcf72271ff798da0a692c2f2ce15373055dbc126df33587b8d418d0f6b67f97a3da2d5d738e1f2f8ce
6
+ metadata.gz: 6afdedc730ec7dc9e10bb0a9f59edbe526359aecef609b2aac5bfd6891bb2ea0e5616ce2fdd22c3470dc04f63fe142a47c90ea46f640b49673040d522b20d77c
7
+ data.tar.gz: af29fa1a2ae37d22117fb22a4303967826a1e9dac19516c6a10b97296f401cd17e760c5db49c38f4dbc512a822cc43adcaa4c4f78687a5784e3adc5876db1052
data/README.md CHANGED
@@ -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/orgpolicy.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-org_policy-v2](https://cloud.google.com/ruby/docs/reference/google-cloud-org_policy-v2/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 OrgPolicy
23
- VERSION = "1.4.1"
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 OrgPolicy service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::OrgPolicy.org_policy_available?}.
65
+ #
61
66
  # ## About OrgPolicy
62
67
  #
63
68
  # An interface for managing organization policies.
@@ -98,6 +103,37 @@ module Google
98
103
  service_module.const_get(:Client).new(&block)
99
104
  end
100
105
 
106
+ ##
107
+ # Determines whether the OrgPolicy service is supported by the current client.
108
+ # If true, you can retrieve a client object by calling {Google::Cloud::OrgPolicy.org_policy}.
109
+ # If false, that method will raise an exception. This could happen if the given
110
+ # API version does not exist or does not support the OrgPolicy service,
111
+ # or if the versioned client gem needs an update to support the OrgPolicy service.
112
+ #
113
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
114
+ # Defaults to `:v2`.
115
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
116
+ # @return [boolean] Whether the service is available.
117
+ #
118
+ def self.org_policy_available? version: :v2, transport: :grpc
119
+ require "google/cloud/org_policy/#{version.to_s.downcase}"
120
+ package_name = Google::Cloud::OrgPolicy
121
+ .constants
122
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
123
+ .first
124
+ return false unless package_name
125
+ service_module = Google::Cloud::OrgPolicy.const_get package_name
126
+ return false unless service_module.const_defined? :OrgPolicy
127
+ service_module = service_module.const_get :OrgPolicy
128
+ if transport == :rest
129
+ return false unless service_module.const_defined? :Rest
130
+ service_module = service_module.const_get :Rest
131
+ end
132
+ service_module.const_defined? :Client
133
+ rescue ::LoadError
134
+ false
135
+ end
136
+
101
137
  ##
102
138
  # Configure the google-cloud-org_policy library.
103
139
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-org_policy
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.1
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-08-09 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-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.2
82
79
  specification_version: 4
83
80
  summary: API Client library for the Organization Policy API
84
81
  test_files: []