google-cloud-datastream 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: 689896a2518c0d305175b8b31690e1b6b481ab048e3beec8d2a098bcfbadd2c6
4
- data.tar.gz: 9687ac96c56f02d91dd669a164ec8df3de16c38b34550fc970b17490a2b5c81d
3
+ metadata.gz: 7b128410f9c23d29be8953590ba1bc4706ac2208924eda213136774b2d658551
4
+ data.tar.gz: fd95a94d938b177e99c989a80a82ff18ae199da1a7fefaa1af7eaf96561218ce
5
5
  SHA512:
6
- metadata.gz: 15b297a0132930199850bad6e5de951a8a47eb5fe00d41c85cdd299f03dc152aa73f1324f26ab336ae3980607afd49a26f2994847dd9428926d23229357560ac
7
- data.tar.gz: cd950e0d07e6595d757a82d019bb29cf6b12eb5b40406cbad88da0ad909588c88090cbed044ffb8b0c80ada051fda480be2e5eef759444d710e52489d7d3fe44
6
+ metadata.gz: ea8355e8287057ae10d3e6c1bbfac92455ee910bfeaf9156ae0f5a3a72d58078d67a630e20c30e8c39a25c4aa50b6a39cd9552820d7df5086512ca3a20a9c2dd
7
+ data.tar.gz: 2a9fe9bd45e3543ad0f8d6c6b5faecdb725967b3d79c2d5f348692b531efb050923aa36a7b508112e145c0f6422b39061d615d2eb8c455950f9f84b1ec801320
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/datastream.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-datastream-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-datastream-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 Datastream
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 Datastream service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::Datastream.datastream_available?}.
65
+ #
61
66
  # ## About Datastream
62
67
  #
63
68
  # Datastream service
@@ -79,6 +84,37 @@ module Google
79
84
  service_module.const_get(:Client).new(&block)
80
85
  end
81
86
 
87
+ ##
88
+ # Determines whether the Datastream service is supported by the current client.
89
+ # If true, you can retrieve a client object by calling {Google::Cloud::Datastream.datastream}.
90
+ # If false, that method will raise an exception. This could happen if the given
91
+ # API version does not exist or does not support the Datastream service,
92
+ # or if the versioned client gem needs an update to support the Datastream service.
93
+ #
94
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
95
+ # Defaults to `:v1`.
96
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
97
+ # @return [boolean] Whether the service is available.
98
+ #
99
+ def self.datastream_available? version: :v1, transport: :grpc
100
+ require "google/cloud/datastream/#{version.to_s.downcase}"
101
+ package_name = Google::Cloud::Datastream
102
+ .constants
103
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
104
+ .first
105
+ return false unless package_name
106
+ service_module = Google::Cloud::Datastream.const_get package_name
107
+ return false unless service_module.const_defined? :Datastream
108
+ service_module = service_module.const_get :Datastream
109
+ if transport == :rest
110
+ return false unless service_module.const_defined? :Rest
111
+ service_module = service_module.const_get :Rest
112
+ end
113
+ service_module.const_defined? :Client
114
+ rescue ::LoadError
115
+ false
116
+ end
117
+
82
118
  ##
83
119
  # Configure the google-cloud-datastream library.
84
120
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-datastream
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
@@ -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 Datastream API
85
82
  test_files: []