google-cloud-gke_hub 1.4.1 → 1.5.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: cb086d22b7d60095d9e3210b4bcb12fdbc1b4bfebb2d73a7792d7fb09cca5cb9
4
- data.tar.gz: '0973da9ff8e7b742e32fd01e0e1a2f155d33689bf77979cae7473e05e45af753'
3
+ metadata.gz: cde9e97ee5a6de46911656c1b9ec09039649b2ed5a3d00ec00573c581d4d5bf0
4
+ data.tar.gz: 35bdcc9f550ef4522b6f5064ecdfb47a03a60462c5d9d7b8a5206846e37a1ffb
5
5
  SHA512:
6
- metadata.gz: 0fda732dcae6e28030bf35f59bcfa1242dbc227686466fa69c40189c20b6a0ec6efaa742847ed4882d02250bf48b1eb59bacfce6c55a78cdcc0480359ec29a0d
7
- data.tar.gz: 1002cd3db909699090e45580df18423470d7a52b98e77327ac073db37e6f906eeccd60ee1011aa531ee930be40a7eb2cce174ec66875579c49e7844262d432df
6
+ metadata.gz: 851e240761441e81b9fd712b9ab49e8f31fe941cadb5053b63da0ef3826b58dcbb98a02c6bd44f7cc64b4f500473631222ef311281bc5a6fb662714715add2cc
7
+ data.tar.gz: fb05398961fd3ba835d2ca5752b98b3752f7e8d0d65b5405aa8c5158b9ba2e1f56e19b62c67f32de186296d0b22b09fe932fa56e0b1119402328b6ba6fb10ce2
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/gkehub.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-gke_hub-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_hub-v1/latest),
67
+ [google-cloud-gke_hub-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_hub-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 GkeHub
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 GkeHub service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::GkeHub.gke_hub_available?}.
65
+ #
61
66
  # ## About GkeHub
62
67
  #
63
68
  # The GKE Hub service handles the registration of many Kubernetes clusters to
@@ -95,6 +100,37 @@ module Google
95
100
  service_module.const_get(:Client).new(&block)
96
101
  end
97
102
 
103
+ ##
104
+ # Determines whether the GkeHub service is supported by the current client.
105
+ # If true, you can retrieve a client object by calling {Google::Cloud::GkeHub.gke_hub}.
106
+ # If false, that method will raise an exception. This could happen if the given
107
+ # API version does not exist or does not support the GkeHub service,
108
+ # or if the versioned client gem needs an update to support the GkeHub service.
109
+ #
110
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
111
+ # Defaults to `:v1`.
112
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
113
+ # @return [boolean] Whether the service is available.
114
+ #
115
+ def self.gke_hub_available? version: :v1, transport: :grpc
116
+ require "google/cloud/gke_hub/#{version.to_s.downcase}"
117
+ package_name = Google::Cloud::GkeHub
118
+ .constants
119
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
120
+ .first
121
+ return false unless package_name
122
+ service_module = Google::Cloud::GkeHub.const_get package_name
123
+ return false unless service_module.const_defined? :GkeHub
124
+ service_module = service_module.const_get :GkeHub
125
+ if transport == :rest
126
+ return false unless service_module.const_defined? :Rest
127
+ service_module = service_module.const_get :Rest
128
+ end
129
+ service_module.const_defined? :Client
130
+ rescue ::LoadError
131
+ false
132
+ end
133
+
98
134
  ##
99
135
  # Configure the google-cloud-gke_hub library.
100
136
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-gke_hub
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
@@ -84,7 +83,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
84
83
  licenses:
85
84
  - Apache-2.0
86
85
  metadata: {}
87
- post_install_message:
88
86
  rdoc_options: []
89
87
  require_paths:
90
88
  - lib
@@ -92,15 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
92
90
  requirements:
93
91
  - - ">="
94
92
  - !ruby/object:Gem::Version
95
- version: '2.7'
93
+ version: '3.0'
96
94
  required_rubygems_version: !ruby/object:Gem::Requirement
97
95
  requirements:
98
96
  - - ">="
99
97
  - !ruby/object:Gem::Version
100
98
  version: '0'
101
99
  requirements: []
102
- rubygems_version: 3.5.6
103
- signing_key:
100
+ rubygems_version: 3.6.2
104
101
  specification_version: 4
105
102
  summary: API Client library for the GKE Hub API
106
103
  test_files: []