google-cloud-private_catalog 0.5.0 → 0.6.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: 8d56d45029f4e2dfe3344d18f80e450ffce57f61d1ff9233ddaf0097080ef676
4
- data.tar.gz: 4e31f3317da3e72ce10310a4f7678ed7880b42f69cda865bdbe070068d7bc598
3
+ metadata.gz: 634834e48a0f25946753e1605fccca432a0895115f7b4d0cd3536842a9f3e480
4
+ data.tar.gz: '0865cde11463ab1de587eaab71ec487da0336996e5bac5cc4ea648d2fdf6918d'
5
5
  SHA512:
6
- metadata.gz: 3dbd49083976d4444091b7780be7ab46f96c86364522d095c58418dc0bbef2e052c74b3fe8f16d969575998819840651a1ebb6d46a05ff12d772051c7d7f12c3
7
- data.tar.gz: 84cdaa12258da9373d2bf889c1a7bbcabd5be5d5f3f20fab3e0e8e4cbfe7a654fad5f6ff03f55b719c267aa312e01e33c56622a043210cd95fd5d205c45b10fa
6
+ metadata.gz: 2dbeef1176d190d9e8e25191f950dfe3fcc39df7b5b7fb22e44d02750e7384f7fdd7e08bc80c5c06adc333565f4182df06ca04a111e0645715137c40cff7a255
7
+ data.tar.gz: 6f068ae52b0dea801c96adbcc30cce7620c08ed2a83fcf95be1dda24db94baf6793821b9bf5d29d0fcb26759550b12c28aaea83a74af168475f5bd032e3e6deb
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/cloudprivatecatalog.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-private_catalog-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-private_catalog-v1beta1/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 PrivateCatalog
23
- VERSION = "0.5.0"
23
+ VERSION = "0.6.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 PrivateCatalog service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::PrivateCatalog.private_catalog_available?}.
65
+ #
61
66
  # ## About PrivateCatalog
62
67
  #
63
68
  # `PrivateCatalog` allows catalog consumers to retrieve `Catalog`, `Product`
@@ -99,6 +104,37 @@ module Google
99
104
  service_module.const_get(:Client).new(&block)
100
105
  end
101
106
 
107
+ ##
108
+ # Determines whether the PrivateCatalog service is supported by the current client.
109
+ # If true, you can retrieve a client object by calling {Google::Cloud::PrivateCatalog.private_catalog}.
110
+ # If false, that method will raise an exception. This could happen if the given
111
+ # API version does not exist or does not support the PrivateCatalog service,
112
+ # or if the versioned client gem needs an update to support the PrivateCatalog service.
113
+ #
114
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
115
+ # Defaults to `:v1beta1`.
116
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
117
+ # @return [boolean] Whether the service is available.
118
+ #
119
+ def self.private_catalog_available? version: :v1beta1, transport: :grpc
120
+ require "google/cloud/private_catalog/#{version.to_s.downcase}"
121
+ package_name = Google::Cloud::PrivateCatalog
122
+ .constants
123
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
124
+ .first
125
+ return false unless package_name
126
+ service_module = Google::Cloud::PrivateCatalog.const_get package_name
127
+ return false unless service_module.const_defined? :PrivateCatalog
128
+ service_module = service_module.const_get :PrivateCatalog
129
+ if transport == :rest
130
+ return false unless service_module.const_defined? :Rest
131
+ service_module = service_module.const_get :Rest
132
+ end
133
+ service_module.const_defined? :Client
134
+ rescue ::LoadError
135
+ false
136
+ end
137
+
102
138
  ##
103
139
  # Configure the google-cloud-private_catalog library.
104
140
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-private_catalog
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.0
4
+ version: 0.6.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-core
@@ -63,7 +62,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
63
62
  licenses:
64
63
  - Apache-2.0
65
64
  metadata: {}
66
- post_install_message:
67
65
  rdoc_options: []
68
66
  require_paths:
69
67
  - lib
@@ -71,15 +69,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
71
69
  requirements:
72
70
  - - ">="
73
71
  - !ruby/object:Gem::Version
74
- version: '2.7'
72
+ version: '3.0'
75
73
  required_rubygems_version: !ruby/object:Gem::Requirement
76
74
  requirements:
77
75
  - - ">="
78
76
  - !ruby/object:Gem::Version
79
77
  version: '0'
80
78
  requirements: []
81
- rubygems_version: 3.5.6
82
- signing_key:
79
+ rubygems_version: 3.6.2
83
80
  specification_version: 4
84
81
  summary: API Client library for the Private Catalog API
85
82
  test_files: []