google-cloud-bigquery-data_policies-v1beta1 0.5.1 → 0.7.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: 1dab4053bf7ba3b57f767454a65c72ef435777085d1486ffe41534980c858c69
4
- data.tar.gz: 508e9a7b599c57b2a7bbbb50c837d65fbe4ab085db874d04da3486fac89982b7
3
+ metadata.gz: 284c1cc86875ff37d23aee4d078fc77e5151cfcf21444e1326bb5a501792420b
4
+ data.tar.gz: d309a40ea060be1ab9ba9e35946e840ae3ec7d9b0fdfb4af6d93edc8db2b03d1
5
5
  SHA512:
6
- metadata.gz: a01a7832947392081fd459d63dffcb917982063cca7bb10756ed832ef9569c29b3d8e08a8384e359dc745fdc437291c37b0ff80b6677b3e0ad211d180aab09c6
7
- data.tar.gz: 0f34e18697ca6a1b558551408eab499756d3f76514023bac9ab2c3a8d04ee7a116c4f944340b7a305c95ec3b5d26b3551ae0e20b85a6be712e3cc84d4205ed8d
6
+ metadata.gz: be913ae5b0e92beb8f365a3dde24979dd968393a766c9de89c61619ceaf76b5ee0c73c49f204414166610291f061e551cfd4de37cdd24471cb664f670d8da6b3
7
+ data.tar.gz: 7deb8a595611d2078829b0101155981d2ac9a8f24ca55fbe2973aedc0e94112b611875e678c9a322a6390c4c1097532e5eb73e2538514a75003b2da1e79232e7
data/README.md CHANGED
@@ -43,40 +43,50 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/bigquery/docs)
44
44
  for general usage information.
45
45
 
46
- ## Enabling Logging
47
-
48
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
51
- 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)
52
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
-
54
- Configuring a Ruby stdlib logger:
46
+ ## Debug Logging
47
+
48
+ This library comes with opt-in Debug Logging that can help you troubleshoot
49
+ your application's integration with the API. When logging is activated, key
50
+ events such as requests and responses, along with data payloads and metadata
51
+ such as headers and client configuration, are logged to the standard error
52
+ stream.
53
+
54
+ **WARNING:** Client Library Debug Logging includes your data payloads in
55
+ plaintext, which could include sensitive data such as PII for yourself or your
56
+ customers, private keys, or other security data that could be compromising if
57
+ leaked. Always practice good data hygiene with your application logs, and follow
58
+ the principle of least access. Google also recommends that Client Library Debug
59
+ Logging be enabled only temporarily during active debugging, and not used
60
+ permanently in production.
61
+
62
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
63
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
64
+ list of client library gem names. This will select the default logging behavior,
65
+ which writes logs to the standard error stream. On a local workstation, this may
66
+ result in logs appearing on the console. When running on a Google Cloud hosting
67
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
68
+ results in logs appearing alongside your application logs in the
69
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
70
+
71
+ You can customize logging by modifying the `logger` configuration when
72
+ constructing a client object. For example:
55
73
 
56
74
  ```ruby
75
+ require "google/cloud/bigquery/data_policies/v1beta1"
57
76
  require "logger"
58
77
 
59
- module MyLogger
60
- LOGGER = Logger.new $stderr, level: Logger::WARN
61
- def logger
62
- LOGGER
63
- end
64
- end
65
-
66
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
67
- module GRPC
68
- extend MyLogger
78
+ client = ::Google::Cloud::Bigquery::DataPolicies::V1beta1::DataPolicyService::Client.new do |config|
79
+ config.logger = Logger.new "my-app.log"
69
80
  end
70
81
  ```
71
82
 
72
-
73
83
  ## Google Cloud Samples
74
84
 
75
85
  To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
86
 
77
87
  ## Supported Ruby Versions
78
88
 
79
- This library is supported on Ruby 2.7+.
89
+ This library is supported on Ruby 3.0+.
80
90
 
81
91
  Google provides official support for Ruby versions that are actively supported
82
92
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -198,8 +198,28 @@ module Google
198
198
  universe_domain: @config.universe_domain,
199
199
  channel_args: @config.channel_args,
200
200
  interceptors: @config.interceptors,
201
- channel_pool_config: @config.channel_pool
201
+ channel_pool_config: @config.channel_pool,
202
+ logger: @config.logger
202
203
  )
204
+
205
+ @data_policy_service_stub.stub_logger&.info do |entry|
206
+ entry.set_system_name
207
+ entry.set_service
208
+ entry.message = "Created client for #{entry.service}"
209
+ entry.set_credentials_fields credentials
210
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
211
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
212
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
213
+ end
214
+ end
215
+
216
+ ##
217
+ # The logger used for request/response debug logging.
218
+ #
219
+ # @return [Logger]
220
+ #
221
+ def logger
222
+ @data_policy_service_stub.logger
203
223
  end
204
224
 
205
225
  # Service calls
@@ -289,7 +309,6 @@ module Google
289
309
 
290
310
  @data_policy_service_stub.call_rpc :create_data_policy, request, options: options do |response, operation|
291
311
  yield response, operation if block_given?
292
- return response
293
312
  end
294
313
  rescue ::GRPC::BadStatus => e
295
314
  raise ::Google::Cloud::Error.from_error(e)
@@ -386,7 +405,6 @@ module Google
386
405
 
387
406
  @data_policy_service_stub.call_rpc :update_data_policy, request, options: options do |response, operation|
388
407
  yield response, operation if block_given?
389
- return response
390
408
  end
391
409
  rescue ::GRPC::BadStatus => e
392
410
  raise ::Google::Cloud::Error.from_error(e)
@@ -473,7 +491,6 @@ module Google
473
491
 
474
492
  @data_policy_service_stub.call_rpc :delete_data_policy, request, options: options do |response, operation|
475
493
  yield response, operation if block_given?
476
- return response
477
494
  end
478
495
  rescue ::GRPC::BadStatus => e
479
496
  raise ::Google::Cloud::Error.from_error(e)
@@ -560,7 +577,6 @@ module Google
560
577
 
561
578
  @data_policy_service_stub.call_rpc :get_data_policy, request, options: options do |response, operation|
562
579
  yield response, operation if block_given?
563
- return response
564
580
  end
565
581
  rescue ::GRPC::BadStatus => e
566
582
  raise ::Google::Cloud::Error.from_error(e)
@@ -659,7 +675,7 @@ module Google
659
675
  @data_policy_service_stub.call_rpc :list_data_policies, request, options: options do |response, operation|
660
676
  response = ::Gapic::PagedEnumerable.new @data_policy_service_stub, :list_data_policies, request, response, operation, options
661
677
  yield response, operation if block_given?
662
- return response
678
+ throw :response, response
663
679
  end
664
680
  rescue ::GRPC::BadStatus => e
665
681
  raise ::Google::Cloud::Error.from_error(e)
@@ -749,7 +765,6 @@ module Google
749
765
 
750
766
  @data_policy_service_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
751
767
  yield response, operation if block_given?
752
- return response
753
768
  end
754
769
  rescue ::GRPC::BadStatus => e
755
770
  raise ::Google::Cloud::Error.from_error(e)
@@ -847,7 +862,6 @@ module Google
847
862
 
848
863
  @data_policy_service_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
849
864
  yield response, operation if block_given?
850
- return response
851
865
  end
852
866
  rescue ::GRPC::BadStatus => e
853
867
  raise ::Google::Cloud::Error.from_error(e)
@@ -939,7 +953,6 @@ module Google
939
953
 
940
954
  @data_policy_service_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
941
955
  yield response, operation if block_given?
942
- return response
943
956
  end
944
957
  rescue ::GRPC::BadStatus => e
945
958
  raise ::Google::Cloud::Error.from_error(e)
@@ -989,6 +1002,13 @@ module Google
989
1002
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
990
1003
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
991
1004
  # * (`nil`) indicating no credentials
1005
+ #
1006
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
1007
+ # external source for authentication to Google Cloud, you must validate it before
1008
+ # providing it to a Google API client library. Providing an unvalidated credential
1009
+ # configuration to Google APIs can compromise the security of your systems and data.
1010
+ # For more information, refer to [Validate credential configurations from external
1011
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
992
1012
  # @return [::Object]
993
1013
  # @!attribute [rw] scope
994
1014
  # The OAuth scopes
@@ -1028,6 +1048,11 @@ module Google
1028
1048
  # default endpoint URL. The default value of nil uses the environment
1029
1049
  # universe (usually the default "googleapis.com" universe).
1030
1050
  # @return [::String,nil]
1051
+ # @!attribute [rw] logger
1052
+ # A custom logger to use for request/response debug logging, or the value
1053
+ # `:default` (the default) to construct a default logger, or `nil` to
1054
+ # explicitly disable logging.
1055
+ # @return [::Logger,:default,nil]
1031
1056
  #
1032
1057
  class Configuration
1033
1058
  extend ::Gapic::Config
@@ -1052,6 +1077,7 @@ module Google
1052
1077
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1053
1078
  config_attr :quota_project, nil, ::String, nil
1054
1079
  config_attr :universe_domain, nil, ::String, nil
1080
+ config_attr :logger, :default, ::Logger, nil, :default
1055
1081
 
1056
1082
  # @private
1057
1083
  def initialize parent_config = nil
@@ -22,7 +22,7 @@ module Google
22
22
  module Bigquery
23
23
  module DataPolicies
24
24
  module V1beta1
25
- VERSION = "0.5.1"
25
+ VERSION = "0.7.0"
26
26
  end
27
27
  end
28
28
  end
@@ -28,6 +28,9 @@ module Google
28
28
  # @!attribute [rw] destinations
29
29
  # @return [::Array<::Google::Api::ClientLibraryDestination>]
30
30
  # The destination where API teams want this client library to be published.
31
+ # @!attribute [rw] selective_gapic_generation
32
+ # @return [::Google::Api::SelectiveGapicGeneration]
33
+ # Configuration for which RPCs should be generated in the GAPIC client.
31
34
  class CommonLanguageSettings
32
35
  include ::Google::Protobuf::MessageExts
33
36
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -212,6 +215,12 @@ module Google
212
215
  # enabled. By default, asynchronous REST clients will not be generated.
213
216
  # This feature will be enabled by default 1 month after launching the
214
217
  # feature in preview packages.
218
+ # @!attribute [rw] protobuf_pythonic_types_enabled
219
+ # @return [::Boolean]
220
+ # Enables generation of protobuf code using new types that are more
221
+ # Pythonic which are included in `protobuf>=5.29.x`. This feature will be
222
+ # enabled by default 1 month after launching the feature in preview
223
+ # packages.
215
224
  class ExperimentalFeatures
216
225
  include ::Google::Protobuf::MessageExts
217
226
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,9 +306,28 @@ module Google
297
306
  # @!attribute [rw] common
298
307
  # @return [::Google::Api::CommonLanguageSettings]
299
308
  # Some settings.
309
+ # @!attribute [rw] renamed_services
310
+ # @return [::Google::Protobuf::Map{::String => ::String}]
311
+ # Map of service names to renamed services. Keys are the package relative
312
+ # service names and values are the name to be used for the service client
313
+ # and call options.
314
+ #
315
+ # publishing:
316
+ # go_settings:
317
+ # renamed_services:
318
+ # Publisher: TopicAdmin
300
319
  class GoSettings
301
320
  include ::Google::Protobuf::MessageExts
302
321
  extend ::Google::Protobuf::MessageExts::ClassMethods
322
+
323
+ # @!attribute [rw] key
324
+ # @return [::String]
325
+ # @!attribute [rw] value
326
+ # @return [::String]
327
+ class RenamedServicesEntry
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
303
331
  end
304
332
 
305
333
  # Describes the generator configuration for a method.
@@ -375,6 +403,17 @@ module Google
375
403
  end
376
404
  end
377
405
 
406
+ # This message is used to configure the generation of a subset of the RPCs in
407
+ # a service for client libraries.
408
+ # @!attribute [rw] methods
409
+ # @return [::Array<::String>]
410
+ # An allowlist of the fully qualified names of RPCs that should be included
411
+ # on public client surfaces.
412
+ class SelectiveGapicGeneration
413
+ include ::Google::Protobuf::MessageExts
414
+ extend ::Google::Protobuf::MessageExts::ClassMethods
415
+ end
416
+
378
417
  # The organization for which the client libraries are being published.
379
418
  # Affects the url where generated docs are published, etc.
380
419
  module ClientLibraryOrganization
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-bigquery-data_policies-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.1
4
+ version: 0.7.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-30 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: gapic-common
@@ -16,7 +15,7 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: 0.21.1
18
+ version: 0.25.0
20
19
  - - "<"
21
20
  - !ruby/object:Gem::Version
22
21
  version: 2.a
@@ -26,7 +25,7 @@ dependencies:
26
25
  requirements:
27
26
  - - ">="
28
27
  - !ruby/object:Gem::Version
29
- version: 0.21.1
28
+ version: 0.25.0
30
29
  - - "<"
31
30
  - !ruby/object:Gem::Version
32
31
  version: 2.a
@@ -97,7 +96,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
97
96
  licenses:
98
97
  - Apache-2.0
99
98
  metadata: {}
100
- post_install_message:
101
99
  rdoc_options: []
102
100
  require_paths:
103
101
  - lib
@@ -105,15 +103,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
105
103
  requirements:
106
104
  - - ">="
107
105
  - !ruby/object:Gem::Version
108
- version: '2.7'
106
+ version: '3.0'
109
107
  required_rubygems_version: !ruby/object:Gem::Requirement
110
108
  requirements:
111
109
  - - ">="
112
110
  - !ruby/object:Gem::Version
113
111
  version: '0'
114
112
  requirements: []
115
- rubygems_version: 3.5.6
116
- signing_key:
113
+ rubygems_version: 3.6.2
117
114
  specification_version: 4
118
115
  summary: Allows users to manage BigQuery data policies.
119
116
  test_files: []