google-cloud-bigquery-data_transfer 0.8.0 → 1.1.2

data/README.md

@@ -1,64 +1,53 @@
-# Ruby Client for BigQuery Data Transfer API
+# Ruby Client for the BigQuery Data Transfer Service API
 
-[BigQuery Data Transfer API][Product Documentation]:
-Schedule queries or transfer external data from SaaS applications to Google
-BigQuery on a regular basis.
-- [Client Library Documentation][]
-- [Product Documentation][]
+API Client library for the BigQuery Data Transfer Service API
 
-## Quick Start
-In order to use this library, you first need to go through the following
-steps:
+Schedules queries and transfers external data from SaaS applications to Google BigQuery on a regular basis.
 
-1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-3. [Enable the BigQuery Data Transfer API.](https://console.cloud.google.com/apis/library/bigquerydatatransfer.googleapis.com)
-4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer/latest/file.AUTHENTICATION.html)
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `google-cloud-bigquery-data_transfer-v*`.
+The gem `google-cloud-bigquery-data_transfer` is the main client library that brings the
+verisoned 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?*.
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer/latest)
+for this library, google-cloud-bigquery-data_transfer, to see the convenience methods for
+constructing client objects. Reference documentation for the client objects
+themselves can be found in the client library documentation for the versioned
+client gems:
+[google-cloud-bigquery-data_transfer-v1](https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer-v1/latest).
+
+See also the [Product Documentation](https://cloud.google.com/bigquery/transfer)
+for more usage information.
+
+## Quick Start
 
-### Installation
 ```
 $ gem install google-cloud-bigquery-data_transfer
 ```
 
-### Preview
-#### DataTransferServiceClient
-```rb
-require "google/cloud/bigquery/data_transfer"
-
-data_transfer_client = Google::Cloud::Bigquery::DataTransfer.new
-formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_path(project_id)
+In order to use this library, you first need to go through the following steps:
 
-# Iterate over all results.
-data_transfer_client.list_data_sources(formatted_parent).each do |element|
-  # Process element.
-end
-
-# Or iterate over results one page at a time.
-data_transfer_client.list_data_sources(formatted_parent).each_page do |page|
-  # Process each page at a time.
-  page.each do |element|
-    # Process element.
-  end
-end
-```
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/bigquerydatatransfer.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
 
-### Next Steps
-- Read the [Client Library Documentation][] for BigQuery Data Transfer API
-  to see other available methods on the client.
-- Read the [BigQuery Data Transfer API Product documentation][Product Documentation]
-  to learn more about the product and see How-to Guides.
-- View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
-  to see the full list of Cloud APIs that we cover.
+## Migrating from 0.x versions
 
-[Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer/latest
-[Product Documentation]: https://cloud.google.com/bigquery/transfer/
+The 1.0 release of the google-cloud-bigquery-data_transfer client is a significant upgrade
+based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
+and includes substantial interface changes. Existing code written for earlier
+versions of this library will likely require updates to use this version.
+See the {file:MIGRATING.md MIGRATING.md} document for more information.
 
 ## 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/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
-that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+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:
@@ -89,3 +78,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-bigquery-data_transfer`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-bigquery-data_transfer-v1`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-bigquery-data_transfer`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-bigquery-data_transfer-v1`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/{google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datasource.rb → google-cloud-bigquery-data_transfer.rb}

@@ -1,4 +1,6 @@
-# Copyright 2019 Google LLC
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,14 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-module Google
-  module Cloud
-    module Bigquery
-      module Datatransfer
-        module V1
-        end
-      end
-    end
-  end
-end
+require "google/cloud/bigquery/data_transfer" unless defined? Google::Cloud::Bigquery::DataTransfer::VERSION

data/lib/google/cloud/bigquery/data_transfer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,161 +14,107 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# Require this file early so that the version constant gets defined before
+# requiring "google/cloud". This is because google-cloud-core will load the
+# entrypoint (gem name) file, which in turn re-requires this file (hence
+# causing a require cycle) unless the version constant is already defined.
+require "google/cloud/bigquery/data_transfer/version"
+
+require "googleauth"
+gem "google-cloud-core"
+require "google/cloud" unless defined? ::Google::Cloud.new
+require "google/cloud/config"
 
-require "google/gax"
-require "pathname"
+# Set the default configuration
+::Google::Cloud.configure.add_config! :bigquery_data_transfer do |config|
+  config.add_field! :endpoint,      "bigquerydatatransfer.googleapis.com", match: ::String
+  config.add_field! :credentials,   nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
+  config.add_field! :scope,         nil, match: [::Array, ::String]
+  config.add_field! :lib_name,      nil, match: ::String
+  config.add_field! :lib_version,   nil, match: ::String
+  config.add_field! :interceptors,  nil, match: ::Array
+  config.add_field! :timeout,       nil, match: ::Numeric
+  config.add_field! :metadata,      nil, match: ::Hash
+  config.add_field! :retry_policy,  nil, match: [::Hash, ::Proc]
+  config.add_field! :quota_project, nil, match: ::String
+end
 
 module Google
   module Cloud
     module Bigquery
-      # rubocop:disable LineLength
-
-      ##
-      # # Ruby Client for BigQuery Data Transfer API
-      #
-      # [BigQuery Data Transfer API][Product Documentation]:
-      # Schedule queries or transfer external data from SaaS applications to Google
-      # BigQuery on a regular basis.
-      # - [Product Documentation][]
-      #
-      # ## Quick Start
-      # In order to use this library, you first need to go through the following
-      # steps:
-      #
-      # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-      # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-      # 3. [Enable the BigQuery Data Transfer API.](https://console.cloud.google.com/apis/library/bigquerydatatransfer.googleapis.com)
-      # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer/latest/file.AUTHENTICATION.html)
-      #
-      # ### Installation
-      # ```
-      # $ gem install google-cloud-bigquery-data_transfer
-      # ```
-      #
-      # ### Preview
-      # #### DataTransferServiceClient
-      # ```rb
-      # require "google/cloud/bigquery/data_transfer"
-      #
-      # data_transfer_client = Google::Cloud::Bigquery::DataTransfer.new
-      # formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_path(project_id)
-      #
-      # # Iterate over all results.
-      # data_transfer_client.list_data_sources(formatted_parent).each do |element|
-      #   # Process element.
-      # end
-      #
-      # # Or iterate over results one page at a time.
-      # data_transfer_client.list_data_sources(formatted_parent).each_page do |page|
-      #   # Process each page at a time.
-      #   page.each do |element|
-      #     # Process element.
-      #   end
-      # end
-      # ```
-      #
-      # ### Next Steps
-      # - Read the [BigQuery Data Transfer API Product documentation][Product Documentation]
-      #   to learn more about the product and see How-to Guides.
-      # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
-      #   to see the full list of Cloud APIs that we cover.
-      #
-      # [Product Documentation]: https://cloud.google.com/bigquery/transfer/
-      #
-      # ## 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/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
-      # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
-      # that will write logs to [Stackdriver 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:
-      #
-      # ```ruby
-      # 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
-      # end
-      # ```
-      #
       module DataTransfer
-        # rubocop:enable LineLength
-
-        FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("data_transfer"))
-
-        AVAILABLE_VERSIONS = Dir["#{FILE_DIR}/*"]
-          .select { |file| File.directory?(file) }
-          .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
-          .select { |dir| File.exist?(dir + ".rb") }
-          .map { |dir| File.basename(dir) }
-
         ##
+        # Create a new client object for DataTransferService.
+        #
+        # By default, this returns an instance of
+        # [Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client](https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer-v1/latest/Google/Cloud/Bigquery/DataTransfer/V1/DataTransferService/Client.html)
+        # for version V1 of the API.
+        # However, you can specify specify a different API version by passing it in the
+        # `version` parameter. If the DataTransferService service is
+        # supported by that API version, and the corresponding gem is available, the
+        # appropriate versioned client will be returned.
+        #
+        # ## About DataTransferService
+        #
         # The Google BigQuery Data Transfer Service API enables BigQuery users to
         # configure the transfer of their data from other Google Products into
         # BigQuery. This service contains methods that are end user exposed. It backs
         # up the frontend.
         #
-        # @param version [Symbol, String]
-        #   The major version of the service to be used. By default :v1
-        #   is used.
-        # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
-        #   @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
-        #     Provides the means for authenticating requests made by the client. This parameter can
-        #     be many types.
-        #     A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
-        #     authenticating requests made by this client.
-        #     A `String` will be treated as the path to the keyfile to be used for the construction of
-        #     credentials for this client.
-        #     A `Hash` will be treated as the contents of a keyfile to be used for the construction of
-        #     credentials for this client.
-        #     A `GRPC::Core::Channel` will be used to make calls through.
-        #     A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
-        #     should already be composed with a `GRPC::Core::CallCredentials` object.
-        #     A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
-        #     metadata for requests, generally, to give OAuth credentials.
-        #   @param scopes [Array<String>]
-        #     The OAuth scopes for this service. This parameter is ignored if
-        #     an updater_proc is supplied.
-        #   @param client_config [Hash]
-        #     A Hash for call options for each method. See
-        #     Google::Gax#construct_settings for the structure of
-        #     this data. Falls back to the default config if not specified
-        #     or the specified config is missing data points.
-        #   @param timeout [Numeric]
-        #     The default timeout, in seconds, for calls made through this client.
-        #   @param metadata [Hash]
-        #     Default metadata to be sent with each request. This can be overridden on a per call basis.
-        #   @param service_address [String]
-        #     Override for the service hostname, or `nil` to leave as the default.
-        #   @param service_port [Integer]
-        #     Override for the service port, or `nil` to leave as the default.
-        #   @param exception_transformer [Proc]
-        #     An optional proc that intercepts any exceptions raised during an API call to inject
-        #     custom error handling.
-        def self.new(*args, version: :v1, **kwargs)
-          unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
-            raise "The version: #{version} is not available. The available versions " \
-              "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
-          end
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1`.
+        # @return [DataTransferService::Client] A client object for the specified version.
+        #
+        def self.data_transfer_service version: :v1, &block
+          require "google/cloud/bigquery/data_transfer/#{version.to_s.downcase}"
+
+          package_name = Google::Cloud::Bigquery::DataTransfer
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          package_module = Google::Cloud::Bigquery::DataTransfer.const_get package_name
+          package_module.const_get(:DataTransferService).const_get(:Client).new(&block)
+        end
+
+        ##
+        # Configure the google-cloud-bigquery-data_transfer library.
+        #
+        # The following configuration parameters are supported:
+        #
+        # * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
+        #   The path to the keyfile as a String, the contents of the keyfile as a
+        #   Hash, or a Google::Auth::Credentials object.
+        # * `lib_name` (*type:* `String`) -
+        #   The library name as recorded in instrumentation and logging.
+        # * `lib_version` (*type:* `String`) -
+        #   The library version as recorded in instrumentation and logging.
+        # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
+        #   An array of interceptors that are run before calls are executed.
+        # * `timeout` (*type:* `Numeric`) -
+        #   Default timeout in seconds.
+        # * `metadata` (*type:* `Hash{Symbol=>String}`) -
+        #   Additional gRPC headers to be sent with the call.
+        # * `retry_policy` (*type:* `Hash`) -
+        #   The retry policy. The value is a hash with the following keys:
+        #     * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+        #     * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+        #     * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+        #     * `:retry_codes` (*type:* `Array<String>`) -
+        #       The error codes that should trigger a retry.
+        #
+        # @return [::Google::Cloud::Config] The default configuration used by this library
+        #
+        def self.configure
+          yield ::Google::Cloud.configure.bigquery_data_transfer if block_given?
 
-          require "#{FILE_DIR}/#{version.to_s.downcase}"
-          version_module = Google::Cloud::Bigquery::DataTransfer
-            .constants
-            .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-            .first
-          Google::Cloud::Bigquery::DataTransfer.const_get(version_module).new(*args, **kwargs)
+          ::Google::Cloud.configure.bigquery_data_transfer
         end
       end
     end
   end
 end
+
+helper_path = ::File.join __dir__, "data_transfer", "helpers.rb"
+require "google/cloud/bigquery/data_transfer/helpers" if ::File.file? helper_path

data/lib/google/cloud/bigquery/data_transfer/version.rb

@@ -1,4 +1,6 @@
-# Copyright 2019 Google LLC
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,12 +14,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
 
 module Google
   module Cloud
     module Bigquery
       module DataTransfer
-        VERSION = "0.8.0".freeze
+        VERSION = "1.1.2"
       end
     end
   end