google-cloud-bigquery-data_transfer-v1 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dc98a0216f9b79b237f5c2df3b6f0de5ede88ca709f8cd4e994327a227d29c8
-  data.tar.gz: 634ac33b77c2d07a4d2064c7fff482d488e596bd087ca6855ed1fae442416f83
+  metadata.gz: 3d47946dab28d06416e76d41974ab0221b2b8db65c8c7c020dedfb45d2e09d34
+  data.tar.gz: 9368c47ad6979bfc5b724f03ae80a0fc04f9d24967bfb86c3a9996a3c85aecca
 SHA512:
-  metadata.gz: fda0deecc390eb39f5abd52c160dbefb67d23740c3a769650b27b356a665f46e92928ad3ccfe38a1278781ee45b75e1f6ac217d54d3b0973f9b1926f7c4e32a9
-  data.tar.gz: 937354981b887fd9649ea6b57ce7936686cbb13a095ef5a7a2e2fa49c106603d99e7cfb804d7858a60b6a414d8b822ece743b4449c6862a97b78d255b292871a
+  metadata.gz: e141d4b347a2c5f8574dadbdb3fbf02b20445aa19521125820fb53b2d339bdf2b4bc6dda3394314033d1acfdb2ecc5c44648e87c03a364b237f5972ac963a1f6
+  data.tar.gz: 8ad6c5bc36f7138b46ee81d2cd92649729f166c37555dddf0cdf600ebc8a029911b7eab8793d9d934f073b07628132d133ae87c3ed133c44f1021d58c7ff3c84

data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb

@@ -28,10 +28,7 @@ module Google
             ##
             # Client for the DataTransferService service.
             #
-            # 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.
+            # This API allows users to manage their data transfers into BigQuery.
             #
             class Client
               include Paths
@@ -205,8 +202,7 @@ module Google
               # Service calls
 
               ##
-              # Retrieves a supported data source and returns its settings,
-              # which can be used for UI rendering.
+              # Retrieves a supported data source and returns its settings.
               #
               # @overload get_data_source(request, options = nil)
               #   Pass arguments to `get_data_source` via a request object, either of type
@@ -293,8 +289,7 @@ module Google
               end
 
               ##
-              # Lists supported data sources and returns their settings,
-              # which can be used for UI rendering.
+              # Lists supported data sources and returns their settings.
               #
               # @overload list_data_sources(request, options = nil)
               #   Pass arguments to `list_data_sources` via a request object, either of type
@@ -633,8 +628,8 @@ module Google
               end
 
               ##
-              # Deletes a data transfer configuration,
-              # including any associated transfer runs and logs.
+              # Deletes a data transfer configuration, including any associated transfer
+              # runs and logs.
               #
               # @overload delete_transfer_config(request, options = nil)
               #   Pass arguments to `delete_transfer_config` via a request object, either of type
@@ -1281,7 +1276,7 @@ module Google
               end
 
               ##
-              # Returns information about running and completed jobs.
+              # Returns information about running and completed transfer runs.
               #
               # @overload list_transfer_runs(request, options = nil)
               #   Pass arguments to `list_transfer_runs` via a request object, either of type
@@ -1388,7 +1383,7 @@ module Google
               end
 
               ##
-              # Returns user facing log messages for the data transfer run.
+              # Returns log messages for the transfer run.
               #
               # @overload list_transfer_logs(request, options = nil)
               #   Pass arguments to `list_transfer_logs` via a request object, either of type
@@ -1495,10 +1490,6 @@ module Google
               ##
               # Returns true if valid credentials exist for the given data source and
               # requesting user.
-              # Some data sources doesn't support service account, so we need to talk to
-              # them on behalf of the end user. This API just checks whether we have OAuth
-              # token for the particular user, which is a pre-requisite before user can
-              # create a transfer config.
               #
               # @overload check_valid_creds(request, options = nil)
               #   Pass arguments to `check_valid_creds` via a request object, either of type
@@ -1584,6 +1575,100 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Enroll data sources in a user project. This allows users to create transfer
+              # configurations for these data sources. They will also appear in the
+              # ListDataSources RPC and as such, will appear in the BigQuery UI
+              # 'https://bigquery.cloud.google.com' (and the documents can be found at
+              # https://cloud.google.com/bigquery/bigquery-web-ui and
+              # https://cloud.google.com/bigquery/docs/working-with-transfers).
+              #
+              # @overload enroll_data_sources(request, options = nil)
+              #   Pass arguments to `enroll_data_sources` via a request object, either of type
+              #   {::Google::Cloud::Bigquery::DataTransfer::V1::EnrollDataSourcesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Bigquery::DataTransfer::V1::EnrollDataSourcesRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload enroll_data_sources(name: nil, data_source_ids: nil)
+              #   Pass arguments to `enroll_data_sources` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param name [::String]
+              #     The name of the project resource in the form:
+              #     `projects/{project_id}`
+              #   @param data_source_ids [::Array<::String>]
+              #     Data sources that are enrolled. It is required to provide at least one
+              #     data source id.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Protobuf::Empty]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Protobuf::Empty]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/bigquery/data_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Bigquery::DataTransfer::V1::EnrollDataSourcesRequest.new
+              #
+              #   # Call the enroll_data_sources method.
+              #   result = client.enroll_data_sources request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
+              def enroll_data_sources request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::EnrollDataSourcesRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.enroll_data_sources.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Bigquery::DataTransfer::V1::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.enroll_data_sources.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.enroll_data_sources.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @data_transfer_service_stub.call_rpc :enroll_data_sources, 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)
+              end
+
               ##
               # Configuration class for the DataTransferService API.
               #
@@ -1789,6 +1874,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :check_valid_creds
+                  ##
+                  # RPC-specific configuration for `enroll_data_sources`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :enroll_data_sources
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -1820,6 +1910,8 @@ module Google
                     @list_transfer_logs = ::Gapic::Config::Method.new list_transfer_logs_config
                     check_valid_creds_config = parent_rpcs.check_valid_creds if parent_rpcs.respond_to? :check_valid_creds
                     @check_valid_creds = ::Gapic::Config::Method.new check_valid_creds_config
+                    enroll_data_sources_config = parent_rpcs.enroll_data_sources if parent_rpcs.respond_to? :enroll_data_sources
+                    @enroll_data_sources = ::Gapic::Config::Method.new enroll_data_sources_config
 
                     yield self if block_given?
                   end

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

@@ -32,10 +32,7 @@ module Google
       module DataTransfer
         module V1
           ##
-          # 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.
+          # This API allows users to manage their data transfers into BigQuery.
           #
           # To load this service and instantiate a client:
           #

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

@@ -22,7 +22,7 @@ module Google
     module Bigquery
       module DataTransfer
         module V1
-          VERSION = "0.4.6"
+          VERSION = "0.5.0"
         end
       end
     end

data/lib/google/cloud/bigquery/datatransfer/v1/datatransfer_pb.rb

@@ -174,6 +174,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse" do
       repeated :runs, :message, 1, "google.cloud.bigquery.datatransfer.v1.TransferRun"
     end
+    add_message "google.cloud.bigquery.datatransfer.v1.EnrollDataSourcesRequest" do
+      optional :name, :string, 1
+      repeated :data_source_ids, :string, 2
+    end
   end
 end
 
@@ -210,6 +214,7 @@ module Google
           StartManualTransferRunsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest").msgclass
           StartManualTransferRunsRequest::TimeRange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeRange").msgclass
           StartManualTransferRunsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse").msgclass
+          EnrollDataSourcesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.EnrollDataSourcesRequest").msgclass
         end
       end
     end

data/lib/google/cloud/bigquery/datatransfer/v1/datatransfer_services_pb.rb

@@ -25,10 +25,7 @@ module Google
       module DataTransfer
         module V1
           module 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.
+            # This API allows users to manage their data transfers into BigQuery.
             class Service
 
               include ::GRPC::GenericService
@@ -37,19 +34,17 @@ module Google
               self.unmarshal_class_method = :decode
               self.service_name = 'google.cloud.bigquery.datatransfer.v1.DataTransferService'
 
-              # Retrieves a supported data source and returns its settings,
-              # which can be used for UI rendering.
+              # Retrieves a supported data source and returns its settings.
               rpc :GetDataSource, ::Google::Cloud::Bigquery::DataTransfer::V1::GetDataSourceRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource
-              # Lists supported data sources and returns their settings,
-              # which can be used for UI rendering.
+              # Lists supported data sources and returns their settings.
               rpc :ListDataSources, ::Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesResponse
               # Creates a new data transfer configuration.
               rpc :CreateTransferConfig, ::Google::Cloud::Bigquery::DataTransfer::V1::CreateTransferConfigRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
               # Updates a data transfer configuration.
               # All fields must be set, even if they are not updated.
               rpc :UpdateTransferConfig, ::Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
-              # Deletes a data transfer configuration,
-              # including any associated transfer runs and logs.
+              # Deletes a data transfer configuration, including any associated transfer
+              # runs and logs.
               rpc :DeleteTransferConfig, ::Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferConfigRequest, ::Google::Protobuf::Empty
               # Returns information about a data transfer config.
               rpc :GetTransferConfig, ::Google::Cloud::Bigquery::DataTransfer::V1::GetTransferConfigRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
@@ -71,17 +66,20 @@ module Google
               rpc :GetTransferRun, ::Google::Cloud::Bigquery::DataTransfer::V1::GetTransferRunRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun
               # Deletes the specified transfer run.
               rpc :DeleteTransferRun, ::Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferRunRequest, ::Google::Protobuf::Empty
-              # Returns information about running and completed jobs.
+              # Returns information about running and completed transfer runs.
               rpc :ListTransferRuns, ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsResponse
-              # Returns user facing log messages for the data transfer run.
+              # Returns log messages for the transfer run.
               rpc :ListTransferLogs, ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsResponse
               # Returns true if valid credentials exist for the given data source and
               # requesting user.
-              # Some data sources doesn't support service account, so we need to talk to
-              # them on behalf of the end user. This API just checks whether we have OAuth
-              # token for the particular user, which is a pre-requisite before user can
-              # create a transfer config.
               rpc :CheckValidCreds, ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse
+              # Enroll data sources in a user project. This allows users to create transfer
+              # configurations for these data sources. They will also appear in the
+              # ListDataSources RPC and as such, will appear in the BigQuery UI
+              # 'https://bigquery.cloud.google.com' (and the documents can be found at
+              # https://cloud.google.com/bigquery/bigquery-web-ui and
+              # https://cloud.google.com/bigquery/docs/working-with-transfers).
+              rpc :EnrollDataSources, ::Google::Cloud::Bigquery::DataTransfer::V1::EnrollDataSourcesRequest, ::Google::Protobuf::Empty
             end
 
             Stub = Service.rpc_stub_class

data/lib/google/cloud/bigquery/datatransfer/v1/transfer_pb.rb

@@ -19,6 +19,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :start_time, :message, 1, "google.protobuf.Timestamp"
       optional :end_time, :message, 2, "google.protobuf.Timestamp"
     end
+    add_message "google.cloud.bigquery.datatransfer.v1.UserInfo" do
+      proto3_optional :email, :string, 1
+    end
     add_message "google.cloud.bigquery.datatransfer.v1.TransferConfig" do
       optional :name, :string, 1
       optional :display_name, :string, 3
@@ -35,6 +38,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :dataset_region, :string, 14
       optional :notification_pubsub_topic, :string, 15
       optional :email_preferences, :message, 18, "google.cloud.bigquery.datatransfer.v1.EmailPreferences"
+      proto3_optional :owner_info, :message, 27, "google.cloud.bigquery.datatransfer.v1.UserInfo"
       oneof :destination do
         optional :destination_dataset_id, :string, 2
       end
@@ -92,6 +96,7 @@ module Google
         module V1
           EmailPreferences = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.EmailPreferences").msgclass
           ScheduleOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ScheduleOptions").msgclass
+          UserInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.UserInfo").msgclass
           TransferConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferConfig").msgclass
           TransferRun = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferRun").msgclass
           TransferMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferMessage").msgclass

data/proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb

@@ -22,12 +22,7 @@ module Google
     module Bigquery
       module DataTransfer
         module V1
-          # Represents a data source parameter with validation rules, so that
-          # parameters can be rendered in the UI. These parameters are given to us by
-          # supported data sources, and include all needed information for rendering
-          # and validation.
-          # Thus, whoever uses this api can decide to generate either generic ui,
-          # or custom data source specific forms.
+          # A parameter used to define custom fields in a data source definition.
           # @!attribute [rw] param_id
           #   @return [::String]
           #     Parameter identifier.
@@ -108,8 +103,7 @@ module Google
             end
           end
 
-          # Represents data source metadata. Metadata is sufficient to
-          # render UI and request proper OAuth tokens.
+          # Defines the properties and custom parameters for a data source.
           # @!attribute [r] name
           #   @return [::String]
           #     Output only. Data source resource name.
@@ -266,9 +260,9 @@ module Google
           # A request to create a data transfer configuration. If new credentials are
           # needed for this transfer configuration, an authorization code must be
           # provided. If an authorization code is provided, the transfer configuration
-          # will be associated with the user id corresponding to the
-          # authorization code. Otherwise, the transfer configuration will be associated
-          # with the calling user.
+          # will be associated with the user id corresponding to the authorization code.
+          # Otherwise, the transfer configuration will be associated with the calling
+          # user.
           # @!attribute [rw] parent
           #   @return [::String]
           #     Required. The BigQuery project id where the transfer configuration should be created.
@@ -445,9 +439,7 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # A request to list data transfer runs. UI can use this method to show/filter
-          # specific data transfer runs. The data source can use this method to request
-          # all scheduled transfer runs.
+          # A request to list data transfer runs.
           # @!attribute [rw] parent
           #   @return [::String]
           #     Required. Name of transfer configuration for which transfer runs should be retrieved.
@@ -637,6 +629,21 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # A request to enroll a set of data sources so they are visible in the
+          # BigQuery UI's `Transfer` tab.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The name of the project resource in the form:
+          #     `projects/{project_id}`
+          # @!attribute [rw] data_source_ids
+          #   @return [::Array<::String>]
+          #     Data sources that are enrolled. It is required to provide at least one
+          #     data source id.
+          class EnrollDataSourcesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

data/proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb

@@ -57,6 +57,15 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Information about a user.
+          # @!attribute [rw] email
+          #   @return [::String]
+          #     E-mail address of the user.
+          class UserInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Represents a data transfer configuration. A transfer configuration
           # contains all metadata needed to perform a data transfer. For example,
           # `destination_dataset_id` specifies where data should be stored.
@@ -99,7 +108,9 @@ module Google
           #     `first sunday of quarter 00:00`.
           #     See more explanation about the format here:
           #     https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
-          #     NOTE: the granularity should be at least 8 hours, or less frequent.
+          #
+          #     NOTE: The minimum interval time between recurring transfers depends on the
+          #     data source; refer to the documentation for your data source.
           # @!attribute [rw] schedule_options
           #   @return [::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleOptions]
           #     Options customizing the data transfer schedule.
@@ -141,6 +152,11 @@ module Google
           #   @return [::Google::Cloud::Bigquery::DataTransfer::V1::EmailPreferences]
           #     Email notifications will be sent according to these preferences
           #     to the email address of the user who owns this transfer config.
+          # @!attribute [r] owner_info
+          #   @return [::Google::Cloud::Bigquery::DataTransfer::V1::UserInfo]
+          #     Output only. Information about the user whose credentials are used to transfer data.
+          #     Populated only for `transferConfigs.get` requests. In case the user
+          #     information is not available, this field will not be populated.
           class TransferConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery-data_transfer-v1
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: API Client library for the BigQuery Data Transfer Service V1 API