google-cloud-data_labeling 0.5.1 → 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: 70249d2fbd3fdee9444b87ad627ed7470ffad3f67fe8d89aead62eac7b2c353c
4
- data.tar.gz: f68fda890e2392c03b986ac93eceabe282956c7d6aae12143fdf7288403c03d7
3
+ metadata.gz: 31385a86a5028d4479866763db8fd242165b59a2f5ececf8a8031cb8da2dc449
4
+ data.tar.gz: d0f150851a37feee77749b9f93dbdcf68180bced214b8cfb7f980846861fb33c
5
5
  SHA512:
6
- metadata.gz: 8b23e57b071a17165078ee7f600b1565c013cebaea9c9d7c5c562708dbafbe677e4b6e6294fe838e416ab0cbb199cb908960aaa09e5ced6aa119f0fafb4329f0
7
- data.tar.gz: e59c5e7c05eb19c5057474e9002271a4f50c9e9f3225be2e4408abb7ac569be833e27fb6a4c5c016b30830937fb68df812a224f60ad509c32204058f0ca347ac
6
+ metadata.gz: f3e6c8977e5f042cb4d9bf96c8d3e1855a751d30de17009e18b098e3abd263466fd27b3d26c4feceb00e418624eca0df779ddafb9bb683272520dc31ddda50f9
7
+ data.tar.gz: e704b9060b4c90887895b73b90c7e2aaf66ecd07cd00ff67e6e686b559c2edbb6c525e172fca5d4fe07723b4389d97478be875493d529c94bdd2850e4f862f89
data/README.md CHANGED
@@ -34,35 +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/datalabeling.googleapis.com)
35
35
  1. {file:AUTHENTICATION.md Set up authentication.}
36
36
 
37
- ## Enabling Logging
38
-
39
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
40
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
41
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
42
- that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
43
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
44
-
45
- Configuring a Ruby stdlib logger:
46
-
47
- ```ruby
48
- require "logger"
49
-
50
- module MyLogger
51
- LOGGER = Logger.new $stderr, level: Logger::WARN
52
- def logger
53
- LOGGER
54
- end
55
- end
56
-
57
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
58
- module GRPC
59
- extend MyLogger
60
- end
61
- ```
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-data_labeling-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-data_labeling-v1beta1/latest).
62
66
 
63
67
  ## Supported Ruby Versions
64
68
 
65
- This library is supported on Ruby 2.7+.
69
+ This library is supported on Ruby 3.0+.
66
70
 
67
71
  Google provides official support for Ruby versions that are actively supported
68
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 DataLabeling
23
- VERSION = "0.5.1"
23
+ VERSION = "0.6.0"
24
24
  end
25
25
  end
26
26
  end
@@ -56,6 +56,11 @@ module Google
56
56
  # supported by that API version, and the corresponding gem is available, the
57
57
  # appropriate versioned client will be returned.
58
58
  #
59
+ # Raises an exception if the currently installed versioned client gem for the
60
+ # given API version does not support the DataLabelingService service.
61
+ # You can determine whether the method will succeed by calling
62
+ # {Google::Cloud::DataLabeling.data_labeling_service_available?}.
63
+ #
59
64
  # ## About DataLabelingService
60
65
  #
61
66
  # Service for the AI Platform Data Labeling API.
@@ -75,6 +80,32 @@ module Google
75
80
  service_module.const_get(:Client).new(&block)
76
81
  end
77
82
 
83
+ ##
84
+ # Determines whether the DataLabelingService service is supported by the current client.
85
+ # If true, you can retrieve a client object by calling {Google::Cloud::DataLabeling.data_labeling_service}.
86
+ # If false, that method will raise an exception. This could happen if the given
87
+ # API version does not exist or does not support the DataLabelingService service,
88
+ # or if the versioned client gem needs an update to support the DataLabelingService service.
89
+ #
90
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
91
+ # Defaults to `:v1beta1`.
92
+ # @return [boolean] Whether the service is available.
93
+ #
94
+ def self.data_labeling_service_available? version: :v1beta1
95
+ require "google/cloud/data_labeling/#{version.to_s.downcase}"
96
+ package_name = Google::Cloud::DataLabeling
97
+ .constants
98
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
99
+ .first
100
+ return false unless package_name
101
+ service_module = Google::Cloud::DataLabeling.const_get package_name
102
+ return false unless service_module.const_defined? :DataLabelingService
103
+ service_module = service_module.const_get :DataLabelingService
104
+ service_module.const_defined? :Client
105
+ rescue ::LoadError
106
+ false
107
+ end
108
+
78
109
  ##
79
110
  # Configure the google-cloud-data_labeling library.
80
111
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-data_labeling
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.1
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-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 AI Platform Data Labeling Service API
85
82
  test_files: []