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