google-cloud-vision_ai 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b983882e98362956b45248be51722e2aebd3a5dfcbc47b90129f71c654c1d56a
-  data.tar.gz: 4b6a53a649650fc377f35dd4b6d6a85d7a8e8e06a4ab60fdead3d43da62932bb
+  metadata.gz: 54e6687ed0e7c0c2a9ac99afb3fdbb10cc1dff0e6bc9469af8076f09321480a1
+  data.tar.gz: 48101540545e0ba4d956e180ae646453af4d7923aba00966198984cbf2832104
 SHA512:
-  metadata.gz: 19f6daa198023f073974efb4ceda4beda16a9d56296421261b4577ce64bbfc8580404d5525967a3d317c31190a6768df42b783dc7184f9f1a1b9f86a3451e131
-  data.tar.gz: b57102ba9f7f2ee146eb68b746ae0effa97133cd62fb8fdcb57a161fefd487c61a58e1ab851422bb3db5b687869e4c39156ac53abd8a48e77faf36b0b19a1758
+  metadata.gz: e78e45530dd42e031a352b6f35f0ee48070df9b93aa117c0908e0de9db9989a87ff56715df384b5f2e6cc61c6b6f4d4881ffdd7d04eb00e053fb3d62d2e8a850
+  data.tar.gz: 930afbb4a2632a7b07332b489eb986f86dc81c1bad8162cfbe778f2502b0c92852c14d7731e710988eb9305d98f0a8d702c30f978d8258602607387458921a70

data/README.md

@@ -34,9 +34,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/visionai.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+## 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.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-vision_ai-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/cloud/vision_ai/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module VisionAI
-      VERSION = "0.1.1"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/google/cloud/vision_ai.rb

@@ -58,6 +58,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the LiveVideoAnalytics service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::VisionAI.live_video_analytics_available?}.
+      #
       # ## About LiveVideoAnalytics
       #
       # Service describing handlers for resources. The service enables clients to run
@@ -80,6 +85,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the LiveVideoAnalytics service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::VisionAI.live_video_analytics}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the LiveVideoAnalytics service,
+      # or if the versioned client gem needs an update to support the LiveVideoAnalytics service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.live_video_analytics_available? version: :v1, transport: :grpc
+        require "google/cloud/vision_ai/#{version.to_s.downcase}"
+        package_name = Google::Cloud::VisionAI
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::VisionAI.const_get package_name
+        return false unless service_module.const_defined? :LiveVideoAnalytics
+        service_module = service_module.const_get :LiveVideoAnalytics
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for AppPlatform.
       #
@@ -93,6 +129,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the AppPlatform service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::VisionAI.app_platform_available?}.
+      #
       # ## About AppPlatform
       #
       # Service describing handlers for resources
@@ -114,6 +155,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the AppPlatform service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::VisionAI.app_platform}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the AppPlatform service,
+      # or if the versioned client gem needs an update to support the AppPlatform service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.app_platform_available? version: :v1, transport: :grpc
+        require "google/cloud/vision_ai/#{version.to_s.downcase}"
+        package_name = Google::Cloud::VisionAI
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::VisionAI.const_get package_name
+        return false unless service_module.const_defined? :AppPlatform
+        service_module = service_module.const_get :AppPlatform
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for StreamingService.
       #
@@ -127,6 +199,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the StreamingService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::VisionAI.streaming_service_available?}.
+      #
       # ## About StreamingService
       #
       # Streaming service for receiving and sending packets.
@@ -148,6 +225,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the StreamingService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::VisionAI.streaming_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the StreamingService service,
+      # or if the versioned client gem needs an update to support the StreamingService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.streaming_service_available? version: :v1, transport: :grpc
+        require "google/cloud/vision_ai/#{version.to_s.downcase}"
+        package_name = Google::Cloud::VisionAI
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::VisionAI.const_get package_name
+        return false unless service_module.const_defined? :StreamingService
+        service_module = service_module.const_get :StreamingService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for StreamsService.
       #
@@ -161,6 +269,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the StreamsService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::VisionAI.streams_service_available?}.
+      #
       # ## About StreamsService
       #
       # Service describing handlers for resources.
@@ -185,6 +298,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the StreamsService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::VisionAI.streams_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the StreamsService service,
+      # or if the versioned client gem needs an update to support the StreamsService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.streams_service_available? version: :v1, transport: :grpc
+        require "google/cloud/vision_ai/#{version.to_s.downcase}"
+        package_name = Google::Cloud::VisionAI
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::VisionAI.const_get package_name
+        return false unless service_module.const_defined? :StreamsService
+        service_module = service_module.const_get :StreamsService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for Warehouse.
       #
@@ -198,6 +342,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the Warehouse service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::VisionAI.warehouse_available?}.
+      #
       # ## About Warehouse
       #
       # Service that manages media content + metadata for streaming.
@@ -219,6 +368,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Warehouse service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::VisionAI.warehouse}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Warehouse service,
+      # or if the versioned client gem needs an update to support the Warehouse service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.warehouse_available? version: :v1, transport: :grpc
+        require "google/cloud/vision_ai/#{version.to_s.downcase}"
+        package_name = Google::Cloud::VisionAI
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::VisionAI.const_get package_name
+        return false unless service_module.const_defined? :Warehouse
+        service_module = service_module.const_get :Warehouse
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for HealthCheckService.
       #
@@ -232,6 +412,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the HealthCheckService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::VisionAI.health_check_service_available?}.
+      #
       # ## About HealthCheckService
       #
       # HealthCheckService provides an interface for Vertex AI Vision Cluster Health
@@ -254,6 +439,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the HealthCheckService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::VisionAI.health_check_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the HealthCheckService service,
+      # or if the versioned client gem needs an update to support the HealthCheckService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.health_check_service_available? version: :v1, transport: :grpc
+        require "google/cloud/vision_ai/#{version.to_s.downcase}"
+        package_name = Google::Cloud::VisionAI
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::VisionAI.const_get package_name
+        return false unless service_module.const_defined? :HealthCheckService
+        service_module = service_module.const_get :HealthCheckService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-vision_ai library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-vision_ai
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -62,7 +61,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,15 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: API Client library for the Vision AI API
 test_files: []