grafeas-v1 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c9af18ba0c00c9b36878af64d7461045a1124310d2b707277a6a6669b3623ec
-  data.tar.gz: cabc333552595a998a347f783b8ae07d2fd9063070cb0c77573a76dd62bbfd52
+  metadata.gz: 765f71ee1f820ff24854e38d4b13a739a407180d4466e45d23e4450c4e9f124c
+  data.tar.gz: 3a3de502ddc7e5d58013c001f56e7f68a610af024877045d90fa1b57d941e7f3
 SHA512:
-  metadata.gz: 5b4ebd562779d431c7e7e4c47d21bcd4f0fe087909e19bc7b45e170cf64a10039c095e1ccd75bcc1e5c347a1af54107002473b4bdb5f2c45559fc80aa960e052
-  data.tar.gz: d947fac16642359d999c9fdef8d38eddb8bdf280b523ee36eb0c6731b4621f26763178b8825401ac4e05cf340930f999fd8d5b66b02fc8e6ad4d6dc48e49723d
+  metadata.gz: 7a1dc5f8bee9d1d1728d69ef64d90f603d3c4da162ffdee852045605102c7dadfc5db2a09736cfe4bc30f12bc0841842526de14cf75453d782a10bcdf591d757
+  data.tar.gz: 3deca38b4736014bd271a735754caf751a453678d6164a6118b347ef8e0dd5d094528d9f314e6b6e13518427ba5f5d81d48f70ed5ba980eb6d12613c4031eec3

data/README.md

@@ -31,33 +31,43 @@ response = client.get_occurrence request
 View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/grafeas-v1/latest)
 for class and method documentation.
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-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)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+You can customize logging by modifying the `logger` configuration when
+constructing a client object. For example:
 
 ```ruby
+require "grafeas/v1"
 require "logger"
 
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
+client = ::Grafeas::V1::Grafeas::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
 end
 ```
 
-
 ## Google Cloud Samples
 
 To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).

data/lib/grafeas/v1/grafeas/client.rb

@@ -210,8 +210,28 @@ module Grafeas
             universe_domain: @config.universe_domain,
             channel_args: @config.channel_args,
             interceptors: @config.interceptors,
-            channel_pool_config: @config.channel_pool
+            channel_pool_config: @config.channel_pool,
+            logger: @config.logger
           )
+
+          @grafeas_stub.stub_logger&.info do |entry|
+            entry.set_system_name
+            entry.set_service
+            entry.message = "Created client for #{entry.service}"
+            entry.set_credentials_fields credentials
+            entry.set "customEndpoint", @config.endpoint if @config.endpoint
+            entry.set "defaultTimeout", @config.timeout if @config.timeout
+            entry.set "quotaProject", @quota_project_id if @quota_project_id
+          end
+        end
+
+        ##
+        # The logger used for request/response debug logging.
+        #
+        # @return [Logger]
+        #
+        def logger
+          @grafeas_stub.logger
         end
 
         # Service calls
@@ -297,7 +317,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :get_occurrence, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -396,7 +415,7 @@ module Grafeas
           @grafeas_stub.call_rpc :list_occurrences, request, options: options do |response, operation|
             response = ::Gapic::PagedEnumerable.new @grafeas_stub, :list_occurrences, request, response, operation, options
             yield response, operation if block_given?
-            return response
+            throw :response, response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -485,7 +504,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :delete_occurrence, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -574,7 +592,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :create_occurrence, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -663,7 +680,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :batch_create_occurrences, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -754,7 +770,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :update_occurrence, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -842,7 +857,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :get_occurrence_note, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -929,7 +943,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :get_note, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -1028,7 +1041,7 @@ module Grafeas
           @grafeas_stub.call_rpc :list_notes, request, options: options do |response, operation|
             response = ::Gapic::PagedEnumerable.new @grafeas_stub, :list_notes, request, response, operation, options
             yield response, operation if block_given?
-            return response
+            throw :response, response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -1115,7 +1128,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :delete_note, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -1206,7 +1218,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :create_note, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -1295,7 +1306,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :batch_create_notes, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -1386,7 +1396,6 @@ module Grafeas
 
           @grafeas_stub.call_rpc :update_note, request, options: options do |response, operation|
             yield response, operation if block_given?
-            return response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -1486,7 +1495,7 @@ module Grafeas
           @grafeas_stub.call_rpc :list_note_occurrences, request, options: options do |response, operation|
             response = ::Gapic::PagedEnumerable.new @grafeas_stub, :list_note_occurrences, request, response, operation, options
             yield response, operation if block_given?
-            return response
+            throw :response, response
           end
         rescue ::GRPC::BadStatus => e
           raise ::Google::Cloud::Error.from_error(e)
@@ -1575,6 +1584,11 @@ module Grafeas
         #   default endpoint URL. The default value of nil uses the environment
         #   universe (usually the default "googleapis.com" universe).
         #   @return [::String,nil]
+        # @!attribute [rw] logger
+        #   A custom logger to use for request/response debug logging, or the value
+        #   `:default` (the default) to construct a default logger, or `nil` to
+        #   explicitly disable logging.
+        #   @return [::Logger,:default,nil]
         #
         class Configuration
           extend ::Gapic::Config
@@ -1599,6 +1613,7 @@ module Grafeas
           config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
           config_attr :quota_project, nil, ::String, nil
           config_attr :universe_domain, nil, ::String, nil
+          config_attr :logger, :default, ::Logger, nil, :default
 
           # @private
           def initialize parent_config = nil

data/lib/grafeas/v1/version.rb

@@ -19,6 +19,6 @@
 
 module Grafeas
   module V1
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/proto_docs/google/api/client.rb

@@ -28,6 +28,9 @@ module Google
     # @!attribute [rw] destinations
     #   @return [::Array<::Google::Api::ClientLibraryDestination>]
     #     The destination where API teams want this client library to be published.
+    # @!attribute [rw] selective_gapic_generation
+    #   @return [::Google::Api::SelectiveGapicGeneration]
+    #     Configuration for which RPCs should be generated in the GAPIC client.
     class CommonLanguageSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -196,9 +199,32 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] experimental_features
+    #   @return [::Google::Api::PythonSettings::ExperimentalFeatures]
+    #     Experimental features to be included during client library generation.
     class PythonSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # Experimental features to be included during client library generation.
+      # These fields will be deprecated once the feature graduates and is enabled
+      # by default.
+      # @!attribute [rw] rest_async_io_enabled
+      #   @return [::Boolean]
+      #     Enables generation of asynchronous REST clients if `rest` transport is
+      #     enabled. By default, asynchronous REST clients will not be generated.
+      #     This feature will be enabled by default 1 month after launching the
+      #     feature in preview packages.
+      # @!attribute [rw] protobuf_pythonic_types_enabled
+      #   @return [::Boolean]
+      #     Enables generation of protobuf code using new types that are more
+      #     Pythonic which are included in `protobuf>=5.29.x`. This feature will be
+      #     enabled by default 1 month after launching the feature in preview
+      #     packages.
+      class ExperimentalFeatures
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Settings for Node client libraries.
@@ -280,9 +306,28 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] renamed_services
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map of service names to renamed services. Keys are the package relative
+    #     service names and values are the name to be used for the service client
+    #     and call options.
+    #
+    #     publishing:
+    #       go_settings:
+    #         renamed_services:
+    #           Publisher: TopicAdmin
     class GoSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedServicesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Describes the generator configuration for a method.
@@ -358,6 +403,17 @@ module Google
       end
     end
 
+    # This message is used to configure the generation of a subset of the RPCs in
+    # a service for client libraries.
+    # @!attribute [rw] methods
+    #   @return [::Array<::String>]
+    #     An allowlist of the fully qualified names of RPCs that should be included
+    #     on public client surfaces.
+    class SelectiveGapicGeneration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # The organization for which the client libraries are being published.
     # Affects the url where generated docs are published, etc.
     module ClientLibraryOrganization

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grafeas-v1
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: An implementation of the Grafeas API, which stores, and enables querying