google-cloud-dataflow 0.5.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2816c2e4c7d323922f094140af34e09ff28d11f7759175ed427dad84afef5eed
-  data.tar.gz: 650703bb4d4e2dec597d195967aaf9e96005543eea2e517154c841a7fae9eaba
+  metadata.gz: c9a5c687f6cca7322b2fa8021c17eaf5bb070a5380ba27153c32fcadbc6774f9
+  data.tar.gz: a2b85664420e858d35e89e3ef21b49d0b6d0008cba8e42ba1ab0f62028bde4c4
 SHA512:
-  metadata.gz: c6f65a3f9353223adeb9badc6008006d75458f26f34a6d2733678f498d7f662349dc18761dc74ea51743b0c70362d5441795e547cbb0e1bbb7d12e013c0219f8
-  data.tar.gz: 2a403d84d32039aa24eb5f8f8054cd97c361ac71de30ea61594cc6de54f5f82a7249743eca7c58ddb0bd1471d68f212a188988bb3a7e6c600504d2a3ce23bda0
+  metadata.gz: e864ccf24544372f5acf708b3dcd7089483d5c6f29f4f743f71f56997a6add1f797802a4d1d43e1ebf13da71dea4cfe3cd31ddb896b468a5c827b70eaedcc4d7
+  data.tar.gz: e98aeb2a53b55ca2cc0df6c73978199ee305cf10f0114c4b57514ef39bf566e952538723560e3e33b959e4e7d100f5f69d0f7875da2638d6818d62d0d27fdca3

data/README.md

@@ -7,7 +7,7 @@ Dataflow is a managed service for executing a wide variety of data processing pa
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-dataflow-v*`.
 The gem `google-cloud-dataflow` is the main client library that brings the
-verisoned gems in as dependencies, and provides high-level methods for
+versioned gems in as dependencies, and provides high-level methods for
 constructing clients. More information on versioned clients can be found below
 in the section titled *Which client should I use?*.
 
@@ -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/dataflow.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-dataflow-v1beta3](https://cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/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/dataflow/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Dataflow
-      VERSION = "0.5.1"
+      VERSION = "0.6.1"
     end
   end
 end

data/lib/google/cloud/dataflow.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 Snapshots service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataflow.snapshots_available?}.
+      #
       # ## About Snapshots
       #
       # Provides methods to manage snapshots of Google Cloud Dataflow jobs.
@@ -79,6 +84,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Snapshots service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataflow.snapshots}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Snapshots service,
+      # or if the versioned client gem needs an update to support the Snapshots service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta3`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.snapshots_available? version: :v1beta3, transport: :grpc
+        require "google/cloud/dataflow/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataflow
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataflow.const_get package_name
+        return false unless service_module.const_defined? :Snapshots
+        service_module = service_module.const_get :Snapshots
+        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 Jobs.
       #
@@ -92,6 +128,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 Jobs service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataflow.jobs_available?}.
+      #
       # ## About Jobs
       #
       # Provides a method to create and modify Google Cloud Dataflow jobs.
@@ -114,6 +155,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Jobs service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataflow.jobs}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Jobs service,
+      # or if the versioned client gem needs an update to support the Jobs service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta3`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.jobs_available? version: :v1beta3, transport: :grpc
+        require "google/cloud/dataflow/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataflow
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataflow.const_get package_name
+        return false unless service_module.const_defined? :Jobs
+        service_module = service_module.const_get :Jobs
+        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 Messages.
       #
@@ -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 Messages service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataflow.messages_available?}.
+      #
       # ## About Messages
       #
       # The Dataflow Messages API is used for monitoring the progress of
@@ -149,6 +226,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Messages service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataflow.messages}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Messages service,
+      # or if the versioned client gem needs an update to support the Messages service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta3`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.messages_available? version: :v1beta3, transport: :grpc
+        require "google/cloud/dataflow/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataflow
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataflow.const_get package_name
+        return false unless service_module.const_defined? :Messages
+        service_module = service_module.const_get :Messages
+        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 Metrics.
       #
@@ -162,6 +270,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 Metrics service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataflow.metrics_available?}.
+      #
       # ## About Metrics
       #
       # The Dataflow Metrics API lets you monitor the progress of Dataflow
@@ -184,6 +297,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the Metrics service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataflow.metrics}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Metrics service,
+      # or if the versioned client gem needs an update to support the Metrics service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta3`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.metrics_available? version: :v1beta3, transport: :grpc
+        require "google/cloud/dataflow/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataflow
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataflow.const_get package_name
+        return false unless service_module.const_defined? :Metrics
+        service_module = service_module.const_get :Metrics
+        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 TemplatesService.
       #
@@ -197,6 +341,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 TemplatesService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataflow.templates_service_available?}.
+      #
       # ## About TemplatesService
       #
       # Provides a method to create Cloud Dataflow jobs from templates.
@@ -218,6 +367,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the TemplatesService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataflow.templates_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 TemplatesService service,
+      # or if the versioned client gem needs an update to support the TemplatesService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta3`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.templates_service_available? version: :v1beta3, transport: :grpc
+        require "google/cloud/dataflow/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataflow
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataflow.const_get package_name
+        return false unless service_module.const_defined? :TemplatesService
+        service_module = service_module.const_get :TemplatesService
+        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 FlexTemplatesService.
       #
@@ -231,6 +411,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 FlexTemplatesService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataflow.flex_templates_service_available?}.
+      #
       # ## About FlexTemplatesService
       #
       # Provides a service for Flex templates. This feature is not ready yet.
@@ -252,6 +437,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the FlexTemplatesService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataflow.flex_templates_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 FlexTemplatesService service,
+      # or if the versioned client gem needs an update to support the FlexTemplatesService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta3`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.flex_templates_service_available? version: :v1beta3, transport: :grpc
+        require "google/cloud/dataflow/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataflow
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataflow.const_get package_name
+        return false unless service_module.const_defined? :FlexTemplatesService
+        service_module = service_module.const_get :FlexTemplatesService
+        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-dataflow library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dataflow
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 1980-01-02 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.8
 specification_version: 4
 summary: API Client library for the Dataflow API
 test_files: []