google-cloud-bigquery-data_transfer 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9449c3fd7f25369d7750c623f59375c89537e3b93b6e09a72fe43becba9dd423
-  data.tar.gz: 1e324e680794d125f2979e0f1e14948859ac0a47963dbf0a47aa7f974bb213e0
+  metadata.gz: dc90505271ff31b135796655d8c8e92c8c3e2e9f3c2a21f32bc8d5525bfd1962
+  data.tar.gz: 9edae69922aa7e185f59e63cc2bca5c36d66478ce785d894c6c536cd97f3fa2e
 SHA512:
-  metadata.gz: f2afcca426da75ace1981dd1e882ff47afd3a1e4d155b984b18e6b4a75cde81625af3ed201a595901d14f91cc378d3b1546e2f49ca3e16f63b5574b4a16653bc
-  data.tar.gz: 744c41803ad08b7f0927f90b67ceef838bc1e960ae51258f9fa5809baee9a76788025b92928ea55c5a6e889a2776a63b828d614e35aad0aac262a7577a212be0
+  metadata.gz: bd0354755bd7183603b23bb85f2c2c08fa5b1f73c0e02c908c481c24eb6b7f1fed0fe66ab8833b1379998e4f769b4928c08503a6930eaf9015f2897b28af0f75
+  data.tar.gz: 90ff6bd37eaaa3f30ec4dae5d580e3491ad3e5a3522f644d4847f98d4108358335ac46ed95235cd6180622fa5dac34af5d0a295814e8ba71686f9917cf4652fc

data/README.md

@@ -13,7 +13,7 @@ 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.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer/latest/file.AUTHENTICATION.html)
 
 ### Installation
 ```
@@ -26,7 +26,7 @@ $ gem install google-cloud-bigquery-data_transfer
 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)
+formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.location_path(project_id, "us-central1")
 
 # Iterate over all results.
 data_transfer_client.list_data_sources(formatted_parent).each do |element|
@@ -50,14 +50,14 @@ end
 - 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.
 
-[Client Library Documentation]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-bigquery-data_transfer/latest/google/cloud/bigquery/datatransfer/v1
+[Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer/latest
 [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.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+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.
 

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

@@ -36,7 +36,7 @@ module Google
       # 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.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+      # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer/latest/file.AUTHENTICATION.html)
       #
       # ### Installation
       # ```
@@ -49,7 +49,7 @@ module Google
       # 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)
+      # formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.location_path(project_id, "us-central1")
       #
       # # Iterate over all results.
       # data_transfer_client.list_data_sources(formatted_parent).each do |element|
@@ -77,7 +77,7 @@ module Google
       #
       # 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.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+      # 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.
       #
@@ -146,6 +146,10 @@ module Google
         #     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.

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

@@ -36,7 +36,7 @@ module Google
         # 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.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+        # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer/latest/file.AUTHENTICATION.html)
         #
         # ### Installation
         # ```
@@ -49,7 +49,7 @@ module Google
         # require "google/cloud/bigquery/data_transfer"
         #
         # data_transfer_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
-        # formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_path(project_id)
+        # formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.location_path(project_id, "us-central1")
         #
         # # Iterate over all results.
         # data_transfer_client.list_data_sources(formatted_parent).each do |element|
@@ -77,7 +77,7 @@ module Google
         #
         # 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.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+        # 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.
         #
@@ -134,6 +134,10 @@ module Google
           #   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.
@@ -143,6 +147,8 @@ module Google
               client_config: nil,
               timeout: nil,
               metadata: nil,
+              service_address: nil,
+              service_port: nil,
               exception_transformer: nil,
               lib_name: nil,
               lib_version: nil
@@ -154,6 +160,8 @@ module Google
               metadata: metadata,
               exception_transformer: exception_transformer,
               lib_name: lib_name,
+              service_address: service_address,
+              service_port: service_port,
               lib_version: lib_version
             }.select { |_, v| v != nil }
             Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.new(**kwargs)

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

@@ -84,6 +84,30 @@ module Google
             ].freeze
 
 
+            LOCATION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "projects/{project}/locations/{location}"
+            )
+
+            private_constant :LOCATION_PATH_TEMPLATE
+
+            LOCATION_DATA_SOURCE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "projects/{project}/locations/{location}/dataSources/{data_source}"
+            )
+
+            private_constant :LOCATION_DATA_SOURCE_PATH_TEMPLATE
+
+            LOCATION_RUN_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}"
+            )
+
+            private_constant :LOCATION_RUN_PATH_TEMPLATE
+
+            LOCATION_TRANSFER_CONFIG_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "projects/{project}/locations/{location}/transferConfigs/{transfer_config}"
+            )
+
+            private_constant :LOCATION_TRANSFER_CONFIG_PATH_TEMPLATE
+
             PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
               "projects/{project}"
             )
@@ -108,6 +132,58 @@ module Google
 
             private_constant :PROJECT_TRANSFER_CONFIG_PATH_TEMPLATE
 
+            # Returns a fully-qualified location resource name string.
+            # @param project [String]
+            # @param location [String]
+            # @return [String]
+            def self.location_path project, location
+              LOCATION_PATH_TEMPLATE.render(
+                :"project" => project,
+                :"location" => location
+              )
+            end
+
+            # Returns a fully-qualified location_data_source resource name string.
+            # @param project [String]
+            # @param location [String]
+            # @param data_source [String]
+            # @return [String]
+            def self.location_data_source_path project, location, data_source
+              LOCATION_DATA_SOURCE_PATH_TEMPLATE.render(
+                :"project" => project,
+                :"location" => location,
+                :"data_source" => data_source
+              )
+            end
+
+            # Returns a fully-qualified location_run resource name string.
+            # @param project [String]
+            # @param location [String]
+            # @param transfer_config [String]
+            # @param run [String]
+            # @return [String]
+            def self.location_run_path project, location, transfer_config, run
+              LOCATION_RUN_PATH_TEMPLATE.render(
+                :"project" => project,
+                :"location" => location,
+                :"transfer_config" => transfer_config,
+                :"run" => run
+              )
+            end
+
+            # Returns a fully-qualified location_transfer_config resource name string.
+            # @param project [String]
+            # @param location [String]
+            # @param transfer_config [String]
+            # @return [String]
+            def self.location_transfer_config_path project, location, transfer_config
+              LOCATION_TRANSFER_CONFIG_PATH_TEMPLATE.render(
+                :"project" => project,
+                :"location" => location,
+                :"transfer_config" => transfer_config
+              )
+            end
+
             # Returns a fully-qualified project resource name string.
             # @param project [String]
             # @return [String]
@@ -178,6 +254,10 @@ module Google
             #   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.
@@ -187,6 +267,8 @@ module Google
                 client_config: {},
                 timeout: DEFAULT_TIMEOUT,
                 metadata: nil,
+                service_address: nil,
+                service_port: nil,
                 exception_transformer: nil,
                 lib_name: nil,
                 lib_version: ""
@@ -241,8 +323,8 @@ module Google
               end
 
               # Allow overriding the service path/port in subclasses.
-              service_path = self.class::SERVICE_ADDRESS
-              port = self.class::DEFAULT_SERVICE_PORT
+              service_path = service_address || self.class::SERVICE_ADDRESS
+              port = service_port || self.class::DEFAULT_SERVICE_PORT
               interceptors = self.class::GRPC_INTERCEPTORS
               @data_transfer_service_stub = Google::Gax::Grpc.create_stub(
                 service_path,
@@ -359,6 +441,14 @@ module Google
                   {'name' => request.name}
                 end
               )
+              @start_manual_transfer_runs = Google::Gax.create_api_call(
+                @data_transfer_service_stub.method(:start_manual_transfer_runs),
+                defaults["start_manual_transfer_runs"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'parent' => request.parent}
+                end
+              )
             end
 
             # Service calls
@@ -455,7 +545,7 @@ module Google
             #
             # @param parent [String]
             #   The BigQuery project id where the transfer configuration should be created.
-            #   Must be in the format /projects/\\{project_id}/locations/\\{location_id}
+            #   Must be in the format projects/\\{project_id}/locations/\\{location_id}
             #   If specified location and location of the destination bigquery dataset
             #   do not match - the request will fail.
             # @param transfer_config [Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig | Hash]
@@ -479,6 +569,13 @@ module Google
             #     urn:ietf:wg:oauth:2.0:oob means that authorization code should be
             #     returned in the title bar of the browser, with the page text prompting
             #     the user to copy the code and paste it in the application.
+            # @param version_info [String]
+            #   Optional version info. If users want to find a very recent access token,
+            #   that is, immediately after approving access, users have to set the
+            #   version_info claim in the token request. To obtain the version_info, users
+            #   must use the "none+gsession" response type. which be return a
+            #   version_info back in the authorization response which be be put in a JWT
+            #   claim in the token request.
             # @param options [Google::Gax::CallOptions]
             #   Overrides the default settings for this call, e.g, timeout,
             #   retries, etc.
@@ -501,12 +598,14 @@ module Google
                 parent,
                 transfer_config,
                 authorization_code: nil,
+                version_info: nil,
                 options: nil,
                 &block
               req = {
                 parent: parent,
                 transfer_config: transfer_config,
-                authorization_code: authorization_code
+                authorization_code: authorization_code,
+                version_info: version_info
               }.delete_if { |_, v| v.nil? }
               req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::CreateTransferConfigRequest)
               @create_transfer_config.call(req, options, &block)
@@ -540,6 +639,13 @@ module Google
             #     urn:ietf:wg:oauth:2.0:oob means that authorization code should be
             #     returned in the title bar of the browser, with the page text prompting
             #     the user to copy the code and paste it in the application.
+            # @param version_info [String]
+            #   Optional version info. If users want to find a very recent access token,
+            #   that is, immediately after approving access, users have to set the
+            #   version_info claim in the token request. To obtain the version_info, users
+            #   must use the "none+gsession" response type. which be return a
+            #   version_info back in the authorization response which be be put in a JWT
+            #   claim in the token request.
             # @param options [Google::Gax::CallOptions]
             #   Overrides the default settings for this call, e.g, timeout,
             #   retries, etc.
@@ -564,12 +670,14 @@ module Google
                 transfer_config,
                 update_mask,
                 authorization_code: nil,
+                version_info: nil,
                 options: nil,
                 &block
               req = {
                 transfer_config: transfer_config,
                 update_mask: update_mask,
-                authorization_code: authorization_code
+                authorization_code: authorization_code,
+                version_info: version_info
               }.delete_if { |_, v| v.nil? }
               req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::UpdateTransferConfigRequest)
               @update_transfer_config.call(req, options, &block)
@@ -701,6 +809,7 @@ module Google
             # For each date - or whatever granularity the data source supports - in the
             # range, one transfer run is created.
             # Note that runs are created per UTC time in the time range.
+            # DEPRECATED: use StartManualTransferRuns instead.
             #
             # @param parent [String]
             #   Transfer configuration name in the form:
@@ -972,6 +1081,52 @@ module Google
               req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::CheckValidCredsRequest)
               @check_valid_creds.call(req, options, &block)
             end
+
+            # Start manual transfer runs to be executed now with schedule_time equal to
+            # current time. The transfer runs can be created for a time range where the
+            # run_time is between start_time (inclusive) and end_time (exclusive), or for
+            # a specific run_time.
+            #
+            # @param parent [String]
+            #   Transfer configuration name in the form:
+            #   `projects/{project_id}/transferConfigs/{config_id}`.
+            # @param requested_time_range [Google::Cloud::Bigquery::Datatransfer::V1::StartManualTransferRunsRequest::TimeRange | Hash]
+            #   Time range for the transfer runs that should be started.
+            #   A hash of the same form as `Google::Cloud::Bigquery::Datatransfer::V1::StartManualTransferRunsRequest::TimeRange`
+            #   can also be provided.
+            # @param requested_run_time [Google::Protobuf::Timestamp | Hash]
+            #   Specific run_time for a transfer run to be started. The
+            #   requested_run_time must not be in the future.
+            #   A hash of the same form as `Google::Protobuf::Timestamp`
+            #   can also be provided.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Cloud::Bigquery::Datatransfer::V1::StartManualTransferRunsResponse]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Cloud::Bigquery::Datatransfer::V1::StartManualTransferRunsResponse]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/cloud/bigquery/data_transfer"
+            #
+            #   data_transfer_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
+            #   response = data_transfer_client.start_manual_transfer_runs
+
+            def start_manual_transfer_runs \
+                parent: nil,
+                requested_time_range: nil,
+                requested_run_time: nil,
+                options: nil,
+                &block
+              req = {
+                parent: parent,
+                requested_time_range: requested_time_range,
+                requested_run_time: requested_run_time
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::StartManualTransferRunsRequest)
+              @start_manual_transfer_runs.call(req, options, &block)
+            end
           end
         end
       end

data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client_config.json

@@ -84,6 +84,11 @@
           "timeout_millis": 30000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
+        },
+        "StartManualTransferRuns": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
         }
       }
     }

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

@@ -25,8 +25,7 @@ module Google
         # | [DataTransferServiceClient][] | The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery. |
         # | [Data Types][] | Data types for Google::Cloud::Bigquery::DataTransfer::V1 |
         #
-        # [DataTransferServiceClient]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-bigquery-data_transfer/latest/google/cloud/bigquery/datatransfer/v1/datatransferserviceclient
-        # [Data Types]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-bigquery-data_transfer/latest/google/cloud/bigquery/datatransfer/v1/datatypes
+        # [DataTransferServiceClient]: https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer/latest/Google/Cloud/Bigquery/DataTransfer/V1/DataTransferServiceClient.html
         #
         module V1
           # Represents a data source parameter with validation rules, so that

data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datasource.rb

@@ -0,0 +1,25 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Google
+  module Cloud
+    module Bigquery
+      module Datatransfer
+        module V1
+        end
+      end
+    end
+  end
+end