google-cloud-bigquery-data_transfer-v1 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6433955b8b3f7bcdb862815a1264b7aded4630fa0e03baad0488ba4efbfd90af
-  data.tar.gz: dd9ce54ca3f027af29a8ff704fb893d863bcfdc8f8c64b4f5e4d5a2f6f6fcc12
+  metadata.gz: 414dd8889ba23effda6a32a344fa660e76a977148767394098c1732f53e076a2
+  data.tar.gz: b805e9aba8f2e5edc6103a92506c7ec98de653c31ddd5cd19f9ba29813f561de
 SHA512:
-  metadata.gz: a4fcd678ba1f117f0df384049f4debf475a1f1b172c8061f55534f07431dd82a6e8801326057771a323f08b0f60849af7f4f8ab5bc05cb8a95201376ff2ef0f0
-  data.tar.gz: ef21e6e47e3d20a10d3c88b9894c1f3e1534fb5531ec6c677321203dd7666d243d59548136cc4605606ffc1acea2dd2d30e34df11779d0315ab2d8a11a453c15
+  metadata.gz: bc02d1135772af2432c562aa2c295022dd6f42479b3b8d4d10295fbf69ca1457a117f7cc8bce5eb218a82d5eb12db21cb43e22ee2b4630951b79203353d0f137
+  data.tar.gz: 0f7f11932f1962208bacda2c12ebfbce80ef2ed824c94b07a4574689da92b9327c4a7d4f86c7933598e04f53f0c0a6b4ef17557a525135b63352b8acbe04ff8d

data/AUTHENTICATION.md

@@ -1,151 +1,122 @@
 # Authentication
 
-In general, the google-cloud-bigquery-data_transfer-v1 library uses
-[Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
-credentials to connect to Google Cloud services. When running within
-[Google Cloud Platform environments](#google-cloud-platform-environments) the
-credentials will be discovered automatically. When running on other
-environments, the Service Account credentials can be specified by providing the
-path to the
-[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
-for the account (or the JSON itself) in
-[environment variables](#environment-variables). Additionally, Cloud SDK
-credentials can also be discovered automatically, but this is only recommended
-during development.
+The recommended way to authenticate to the google-cloud-bigquery-data_transfer-v1 library is to use
+[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
+To review all of your authentication options, see [Credentials lookup](#credential-lookup).
 
 ## Quickstart
 
-1. [Create a service account and credentials](#creating-a-service-account).
-2. Set the [environment variable](#environment-variables).
+The following example shows how to set up authentication for a local development
+environment with your user credentials. 
 
-```sh
-export DATA_TRANSFER_CREDENTIALS=path/to/keyfile.json
-```
-
-3. Initialize the client.
+**NOTE:** This method is _not_ recommended for running in production. User credentials
+should be used only during development.
 
-```ruby
-require "google/cloud/bigquery/data_transfer/v1"
+1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
+2. Set up a local ADC file with your user credentials:
 
-client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new
+```sh
+gcloud auth application-default login
 ```
 
-## Credential Lookup
-
-The google-cloud-bigquery-data_transfer-v1 library aims to make authentication
-as simple as possible, and provides several mechanisms to configure your system
-without requiring **Service Account Credentials** directly in code.
-
-**Credentials** are discovered in the following order:
-
-1. Specify credentials in method arguments
-2. Specify credentials in configuration
-3. Discover credentials path in environment variables
-4. Discover credentials JSON in environment variables
-5. Discover credentials file in the Cloud SDK's path
-6. Discover GCP credentials
-
-### Google Cloud Platform environments
+3. Write code as if already authenticated.
 
-When running on Google Cloud Platform (GCP), including Google Compute Engine
-(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
-Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
-Code should be written as if already authenticated.
+For more information about setting up authentication for a local development environment, see
+[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
 
-### Environment Variables
+## Credential Lookup
 
-The **Credentials JSON** can be placed in environment variables instead of
-declaring them directly in code. Each service has its own environment variable,
-allowing for different service accounts to be used for different services. (See
-the READMEs for the individual service gems for details.) The path to the
-**Credentials JSON** file can be stored in the environment variable, or the
-**Credentials JSON** itself can be stored for environments such as Docker
-containers where writing files is difficult or not encouraged.
+The google-cloud-bigquery-data_transfer-v1 library provides several mechanisms to configure your system.
+Generally, using Application Default Credentials to facilitate automatic 
+credentials discovery is the easist method. But if you need to explicitly specify
+credentials, there are several methods available to you.
 
-The environment variables that google-cloud-bigquery-data_transfer-v1
-checks for credentials are configured on the service Credentials class (such as
-{::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Credentials}):
+Credentials are accepted in the following ways, in the following order or precedence:
 
-* `DATA_TRANSFER_CREDENTIALS` - Path to JSON file, or JSON contents
-* `DATA_TRANSFER_KEYFILE` - Path to JSON file, or JSON contents
-* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+1. Credentials specified in method arguments
+2. Credentials specified in configuration
+3. Credentials pointed to or included in environment variables
+4. Credentials found in local ADC file
+5. Credentials returned by the metadata server for the attached service account (GCP)
 
-```ruby
-require "google/cloud/bigquery/data_transfer/v1"
-
-ENV["DATA_TRANSFER_CREDENTIALS"] = "path/to/keyfile.json"
+### Configuration
 
-client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new
-```
+You can configure a path to a JSON credentials file, either for an individual client object or
+globally, for all client objects. The JSON file can contain credentials created for
+[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
+[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
+[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
 
-### Configuration
+Note: Service account keys are a security risk if not managed correctly. You should
+[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
+whenever possible.
 
-The path to the **Credentials JSON** file can be configured instead of storing
-it in an environment variable. Either on an individual client initialization:
+To configure a credentials file for an individual client initialization:
 
 ```ruby
 require "google/cloud/bigquery/data_transfer/v1"
 
 client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new do |config|
-  config.credentials = "path/to/keyfile.json"
+  config.credentials = "path/to/credentialfile.json"
 end
 ```
 
-Or globally for all clients:
+To configure a credentials file globally for all clients:
 
 ```ruby
 require "google/cloud/bigquery/data_transfer/v1"
 
 ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.configure do |config|
-  config.credentials = "path/to/keyfile.json"
+  config.credentials = "path/to/credentialfile.json"
 end
 
 client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new
 ```
 
-### Cloud SDK
+### Environment Variables
 
-This option allows for an easy way to authenticate during development. If
-credentials are not provided in code or in environment variables, then Cloud SDK
-credentials are discovered.
+You can also use an environment variable to provide a JSON credentials file.
+The environment variable can contain a path to the credentials file or, for
+environments such as Docker containers where writing files is not encouraged,
+you can include the credentials file itself.
 
-To configure your system for this, simply:
+The JSON file can contain credentials created for
+[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
+[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
+[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
 
-1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
-3. Write code as if already authenticated.
+Note: Service account keys are a security risk if not managed correctly. You should
+[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
+whenever possible.
+
+The environment variables that google-cloud-bigquery-data_transfer-v1
+checks for credentials are:
 
-**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
-*should* only be used during development.
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
-## Creating a Service Account
+```ruby
+require "google/cloud/bigquery/data_transfer/v1"
 
-Google Cloud requires **Service Account Credentials** to
-connect to the APIs. You will use the **JSON key file** to
-connect to most services with google-cloud-bigquery-data_transfer-v1.
+ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
 
-If you are not running this client within
-[Google Cloud Platform environments](#google-cloud-platform-environments), you
-need a Google Developers service account.
+client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new
+```
 
-1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
-2. Create a new project or click on an existing project.
-3. Activate the menu in the upper left and select **APIs & Services**. From
-   here, you will enable the APIs that your application requires.
+### Local ADC file
 
-   *Note: You may need to enable billing in order to use these services.*
+You can set up a local ADC file with your user credentials for authentication during
+development. If credentials are not provided in code or in environment variables,
+then the local ADC credentials are discovered.
 
-4. Select **Credentials** from the side navigation.
+Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
 
-   Find the "Create credentials" drop down near the top of the page, and select
-   "Service account" to be guided through downloading a new JSON key file.
+### Google Cloud Platform environments
 
-   If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, click the pencil
-   tool on the right side to edit the service account, select the **Keys** tab,
-   and then select **Add Key**.
+When running on Google Cloud Platform (GCP), including Google Compute Engine
+(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
+Functions (GCF) and Cloud Run, credentials are retrieved from the attached
+service account automatically. Code should be written as if already authenticated.
 
-   The key file you download will be used by this library to authenticate API
-   requests and should be stored in a secure location.
+For more information, see
+[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).

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

@@ -32,6 +32,9 @@ module Google
             # This API allows users to manage their data transfers into BigQuery.
             #
             class Client
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "bigquerydatatransfer.$UNIVERSE_DOMAIN$"
+
               include Paths
 
               # @private
@@ -148,6 +151,15 @@ module Google
                 @config
               end
 
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @data_transfer_service_stub.universe_domain
+              end
+
               ##
               # Create a new DataTransferService client object.
               #
@@ -181,8 +193,9 @@ module Google
                 credentials = @config.credentials
                 # Use self-signed JWT if the endpoint is unchanged from default,
                 # but only if the default endpoint does not have a region prefix.
-                enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
-                                         !@config.endpoint.split(".").first.include?("-")
+                enable_self_signed_jwt = @config.endpoint.nil? ||
+                                         (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                         !@config.endpoint.split(".").first.include?("-"))
                 credentials ||= Credentials.default scope: @config.scope,
                                                     enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -195,14 +208,18 @@ module Google
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
                 end
 
                 @data_transfer_service_stub = ::Gapic::ServiceStub.new(
                   ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Stub,
-                  credentials:  credentials,
-                  endpoint:     @config.endpoint,
+                  credentials: credentials,
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
                   channel_args: @config.channel_args,
-                  interceptors: @config.interceptors
+                  interceptors: @config.interceptors,
+                  channel_pool_config: @config.channel_pool
                 )
               end
 
@@ -1735,9 +1752,9 @@ module Google
               #   end
               #
               # @!attribute [rw] endpoint
-              #   The hostname or hostname:port of the service endpoint.
-              #   Defaults to `"bigquerydatatransfer.googleapis.com"`.
-              #   @return [::String]
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
               # @!attribute [rw] credentials
               #   Credentials to send with calls. You may provide any of the following types:
               #    *  (`String`) The path to a service account key file in JSON format
@@ -1783,13 +1800,20 @@ module Google
               # @!attribute [rw] quota_project
               #   A separate project against which to charge quota.
               #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   default endpoint URL. The default value of nil uses the environment
+              #   universe (usually the default "googleapis.com" universe).
+              #   @return [::String,nil]
               #
               class Configuration
                 extend ::Gapic::Config
 
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
                 DEFAULT_ENDPOINT = "bigquerydatatransfer.googleapis.com"
 
-                config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+                config_attr :endpoint,      nil, ::String, nil
                 config_attr :credentials,   nil do |value|
                   allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                   allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1804,6 +1828,7 @@ module Google
                 config_attr :metadata,      nil, ::Hash, nil
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
+                config_attr :universe_domain, nil, ::String, nil
 
                 # @private
                 def initialize parent_config = nil
@@ -1824,6 +1849,14 @@ module Google
                   end
                 end
 
+                ##
+                # Configuration for the channel pool
+                # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+                #
+                def channel_pool
+                  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+                end
+
                 ##
                 # Configuration RPC class for the DataTransferService API.
                 #

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

@@ -34,6 +34,9 @@ module Google
               # This API allows users to manage their data transfers into BigQuery.
               #
               class Client
+                # @private
+                DEFAULT_ENDPOINT_TEMPLATE = "bigquerydatatransfer.$UNIVERSE_DOMAIN$"
+
                 include Paths
 
                 # @private
@@ -150,6 +153,15 @@ module Google
                   @config
                 end
 
+                ##
+                # The effective universe domain
+                #
+                # @return [String]
+                #
+                def universe_domain
+                  @data_transfer_service_stub.universe_domain
+                end
+
                 ##
                 # Create a new DataTransferService REST client object.
                 #
@@ -177,8 +189,9 @@ module Google
                   credentials = @config.credentials
                   # Use self-signed JWT if the endpoint is unchanged from default,
                   # but only if the default endpoint does not have a region prefix.
-                  enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
-                                           !@config.endpoint.split(".").first.include?("-")
+                  enable_self_signed_jwt = @config.endpoint.nil? ||
+                                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                           !@config.endpoint.split(".").first.include?("-"))
                   credentials ||= Credentials.default scope: @config.scope,
                                                       enable_self_signed_jwt: enable_self_signed_jwt
                   if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -192,10 +205,16 @@ module Google
                     config.credentials = credentials
                     config.quota_project = @quota_project_id
                     config.endpoint = @config.endpoint
+                    config.universe_domain = @config.universe_domain
                     config.bindings_override = @config.bindings_override
                   end
 
-                  @data_transfer_service_stub = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+                  @data_transfer_service_stub = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Rest::ServiceStub.new(
+                    endpoint: @config.endpoint,
+                    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                    universe_domain: @config.universe_domain,
+                    credentials: credentials
+                  )
                 end
 
                 ##
@@ -236,6 +255,22 @@ module Google
                 # @return [::Google::Cloud::Bigquery::DataTransfer::V1::DataSource]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::GetDataSourceRequest.new
+                #
+                #   # Call the get_data_source method.
+                #   result = client.get_data_source request
+                #
+                #   # The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::DataSource.
+                #   p result
+                #
                 def get_data_source request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -308,6 +343,26 @@ module Google
                 # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::DataSource>]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesRequest.new
+                #
+                #   # Call the list_data_sources method.
+                #   result = client.list_data_sources request
+                #
+                #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+                #   # over elements, and API calls will be issued to fetch pages as needed.
+                #   result.each do |item|
+                #     # Each element is of type ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource.
+                #     p item
+                #   end
+                #
                 def list_data_sources request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -417,6 +472,22 @@ module Google
                 # @return [::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::CreateTransferConfigRequest.new
+                #
+                #   # Call the create_transfer_config method.
+                #   result = client.create_transfer_config request
+                #
+                #   # The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.
+                #   p result
+                #
                 def create_transfer_config request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -522,6 +593,22 @@ module Google
                 # @return [::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest.new
+                #
+                #   # Call the update_transfer_config method.
+                #   result = client.update_transfer_config request
+                #
+                #   # The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.
+                #   p result
+                #
                 def update_transfer_config request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -587,6 +674,22 @@ module Google
                 # @return [::Google::Protobuf::Empty]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferConfigRequest.new
+                #
+                #   # Call the delete_transfer_config method.
+                #   result = client.delete_transfer_config request
+                #
+                #   # The returned object is of type Google::Protobuf::Empty.
+                #   p result
+                #
                 def delete_transfer_config request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -651,6 +754,22 @@ module Google
                 # @return [::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::GetTransferConfigRequest.new
+                #
+                #   # Call the get_transfer_config method.
+                #   result = client.get_transfer_config request
+                #
+                #   # The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.
+                #   p result
+                #
                 def get_transfer_config request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -726,6 +845,26 @@ module Google
                 # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig>]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsRequest.new
+                #
+                #   # Call the list_transfer_configs method.
+                #   result = client.list_transfer_configs request
+                #
+                #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+                #   # over elements, and API calls will be issued to fetch pages as needed.
+                #   result.each do |item|
+                #     # Each element is of type ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.
+                #     p item
+                #   end
+                #
                 def list_transfer_configs request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -801,6 +940,22 @@ module Google
                 # @return [::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsRequest.new
+                #
+                #   # Call the schedule_transfer_runs method.
+                #   result = client.schedule_transfer_runs request
+                #
+                #   # The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse.
+                #   p result
+                #
                 def schedule_transfer_runs request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -878,6 +1033,22 @@ module Google
                 # @return [::Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsRequest.new
+                #
+                #   # Call the start_manual_transfer_runs method.
+                #   result = client.start_manual_transfer_runs request
+                #
+                #   # The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse.
+                #   p result
+                #
                 def start_manual_transfer_runs request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -943,6 +1114,22 @@ module Google
                 # @return [::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::GetTransferRunRequest.new
+                #
+                #   # Call the get_transfer_run method.
+                #   result = client.get_transfer_run request
+                #
+                #   # The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::TransferRun.
+                #   p result
+                #
                 def get_transfer_run request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1008,6 +1195,22 @@ module Google
                 # @return [::Google::Protobuf::Empty]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferRunRequest.new
+                #
+                #   # Call the delete_transfer_run method.
+                #   result = client.delete_transfer_run request
+                #
+                #   # The returned object is of type Google::Protobuf::Empty.
+                #   p result
+                #
                 def delete_transfer_run request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1085,6 +1288,26 @@ module Google
                 # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest.new
+                #
+                #   # Call the list_transfer_runs method.
+                #   result = client.list_transfer_runs request
+                #
+                #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+                #   # over elements, and API calls will be issued to fetch pages as needed.
+                #   result.each do |item|
+                #     # Each element is of type ::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun.
+                #     p item
+                #   end
+                #
                 def list_transfer_runs request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1161,6 +1384,26 @@ module Google
                 # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage>]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsRequest.new
+                #
+                #   # Call the list_transfer_logs method.
+                #   result = client.list_transfer_logs request
+                #
+                #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+                #   # over elements, and API calls will be issued to fetch pages as needed.
+                #   result.each do |item|
+                #     # Each element is of type ::Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage.
+                #     p item
+                #   end
+                #
                 def list_transfer_logs request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1227,6 +1470,22 @@ module Google
                 # @return [::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsRequest.new
+                #
+                #   # Call the check_valid_creds method.
+                #   result = client.check_valid_creds request
+                #
+                #   # The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse.
+                #   p result
+                #
                 def check_valid_creds request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1299,6 +1558,22 @@ module Google
                 # @return [::Google::Protobuf::Empty]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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?
 
@@ -1364,9 +1639,9 @@ module Google
                 #   end
                 #
                 # @!attribute [rw] endpoint
-                #   The hostname or hostname:port of the service endpoint.
-                #   Defaults to `"bigquerydatatransfer.googleapis.com"`.
-                #   @return [::String]
+                #   A custom service endpoint, as a hostname or hostname:port. The default is
+                #   nil, indicating to use the default endpoint in the current universe domain.
+                #   @return [::String,nil]
                 # @!attribute [rw] credentials
                 #   Credentials to send with calls. You may provide any of the following types:
                 #    *  (`String`) The path to a service account key file in JSON format
@@ -1403,13 +1678,20 @@ module Google
                 # @!attribute [rw] quota_project
                 #   A separate project against which to charge quota.
                 #   @return [::String]
+                # @!attribute [rw] universe_domain
+                #   The universe domain within which to make requests. This determines the
+                #   default endpoint URL. The default value of nil uses the environment
+                #   universe (usually the default "googleapis.com" universe).
+                #   @return [::String,nil]
                 #
                 class Configuration
                   extend ::Gapic::Config
 
+                  # @private
+                  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
                   DEFAULT_ENDPOINT = "bigquerydatatransfer.googleapis.com"
 
-                  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+                  config_attr :endpoint,      nil, ::String, nil
                   config_attr :credentials,   nil do |value|
                     allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                     allowed.any? { |klass| klass === value }
@@ -1421,6 +1703,7 @@ module Google
                   config_attr :metadata,      nil, ::Hash, nil
                   config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                   config_attr :quota_project, nil, ::String, nil
+                  config_attr :universe_domain, nil, ::String, nil
 
                   # @private
                   # Overrides for http bindings for the RPCs of this service

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

@@ -31,16 +31,28 @@ module Google
               # including transcoding, making the REST call, and deserialing the response.
               #
               class ServiceStub
-                def initialize endpoint:, credentials:
+                def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
                   # These require statements are intentionally placed here to initialize
                   # the REST modules only when it's required.
                   require "gapic/rest"
 
-                  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
+                                                               endpoint_template: endpoint_template,
+                                                               universe_domain: universe_domain,
+                                                               credentials: credentials,
                                                                numeric_enums: true,
                                                                raise_faraday_errors: false
                 end
 
+                ##
+                # The effective universe domain
+                #
+                # @return [String]
+                #
+                def universe_domain
+                  @client_stub.universe_domain
+                end
+
                 ##
                 # Baseline implementation for the get_data_source REST call
                 #

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

@@ -22,7 +22,7 @@ module Google
     module Bigquery
       module DataTransfer
         module V1
-          VERSION = "0.10.0"
+          VERSION = "0.12.0"
         end
       end
     end

data/proto_docs/google/api/client.rb

@@ -21,6 +21,7 @@ module Google
   module Api
     # Required information for every language.
     # @!attribute [rw] reference_docs_uri
+    #   @deprecated This field is deprecated and may be removed in the next major version update.
     #   @return [::String]
     #     Link to automatically generated reference documentation.  Example:
     #     https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
     #                seconds: 360 # 6 minutes
     #              total_poll_timeout:
     #                 seconds: 54000 # 90 minutes
+    # @!attribute [rw] auto_populated_fields
+    #   @return [::Array<::String>]
+    #     List of top-level fields of the request message, that should be
+    #     automatically populated by the client libraries based on their
+    #     (google.api.field_info).format. Currently supported format: UUID4.
+    #
+    #     Example of a YAML configuration:
+    #
+    #      publishing:
+    #        method_settings:
+    #          - selector: google.example.v1.ExampleService.CreateExample
+    #            auto_populated_fields:
+    #            - request_id
     class MethodSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/api/field_behavior.rb

@@ -66,6 +66,20 @@ module Google
       # a non-empty value will be returned. The user will not be aware of what
       # non-empty value to expect.
       NON_EMPTY_DEFAULT = 7
+
+      # Denotes that the field in a resource (a message annotated with
+      # google.api.resource) is used in the resource name to uniquely identify the
+      # resource. For AIP-compliant APIs, this should only be applied to the
+      # `name` field on the resource.
+      #
+      # This behavior should not be applied to references to other resources within
+      # the message.
+      #
+      # The identifier field of resources often have different field behavior
+      # depending on the request it is embedded in (e.g. for Create methods name
+      # is optional and unused, while for Update methods it is required). Instead
+      # of method-specific annotations, only `IDENTIFIER` is required.
+      IDENTIFIER = 8
     end
   end
 end

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

@@ -128,9 +128,11 @@ module Google
           #     scopes needed by a data source to prepare data and ingest them into
           #     BigQuery, e.g., https://www.googleapis.com/auth/bigquery
           # @!attribute [rw] transfer_type
+          #   @deprecated This field is deprecated and may be removed in the next major version update.
           #   @return [::Google::Cloud::Bigquery::DataTransfer::V1::TransferType]
           #     Deprecated. This field has no effect.
           # @!attribute [rw] supports_multiple_transfers
+          #   @deprecated This field is deprecated and may be removed in the next major version update.
           #   @return [::Boolean]
           #     Deprecated. This field has no effect.
           # @!attribute [rw] update_deadline_seconds

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

@@ -75,9 +75,10 @@ module Google
           # @!attribute [rw] name
           #   @return [::String]
           #     The resource name of the transfer config.
-          #     Transfer config names have the form
-          #     `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
-          #     Where `config_id` is usually a uuid, even though it is not
+          #     Transfer config names have the form either
+          #     `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or
+          #     `projects/{project_id}/transferConfigs/{config_id}`,
+          #     where `config_id` is usually a UUID, even though it is not
           #     guaranteed or required. The name is ignored when creating a transfer
           #     config.
           # @!attribute [rw] destination_dataset_id
@@ -282,6 +283,7 @@ module Google
           end
 
           # DEPRECATED. Represents data transfer type.
+          # @deprecated This enum is deprecated and may be removed in the next major version update.
           module TransferType
             # Invalid or Unknown transfer type placeholder.
             TRANSFER_TYPE_UNSPECIFIED = 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery-data_transfer-v1
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-03 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.21.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.21.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -60,7 +60,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -239,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Schedule queries or transfer external data from SaaS applications to Google