google-cloud-bigquery-storage-v1 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77198ebddfdbb67030c0ec87f154f2f859697d4ee7fb6eee67ebd9b9a5bdbcae
-  data.tar.gz: 2360b033006a2b201ec2443284211fc8f58b1bf164afce4414bdc2c4c8c50f44
+  metadata.gz: 6693e2ad11b7bf193b9fc692f91d7ffb59251df9fa28ba3ea24f6e77e385bba1
+  data.tar.gz: d52647196c983df0ae4cba7fe40267b3ef1d394693257a35a6eefa1b5f75502c
 SHA512:
-  metadata.gz: 5bf4d88060d68f4c763cc82804a1651f51f1596e64cd947af3da0f24ceca916cc88f11ac68391314de8eeb78872bc0c6faf63aa27d42ca0d37cac830c6357e92
-  data.tar.gz: 5755120deef5c2274dab74c49c6c251880358583f78d3e8848f0c6c26da6f68da279b61fbbfc6900746c461f52c5e8a2d76e9c36cf911deb4bf0ffff8cfac206
+  metadata.gz: 1a384535064401bb446fc3464358e076be4f6c99dd3d16e15e43e1d73c5d165dbc3cd2e3176dd9ccba0ca7eb728dca959bc26103e88ac433bd3fd3ce14edb4d1
+  data.tar.gz: 338a6b1f618ec95fcd662d0b033b0543324e0de62660e51972a52d3872f7c7071387e055474abd2877c2cd75768407f35d3535e6064cafcd284673d815d4f20d

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-bigquery-storage-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Credentials}):
 
-1. `BIGQUERY_STORAGE_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `BIGQUERY_STORAGE_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `BIGQUERY_STORAGE_CREDENTIALS` - Path to JSON file, or JSON contents
+* `BIGQUERY_STORAGE_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
 
 ```ruby
 require "google/cloud/bigquery/storage/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/bigquery/storage/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new do |co
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/bigquery/storage/v1"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/bigquery/storage/v1"
 
 client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
-request = my_create_request
+request = ::Google::Cloud::Bigquery::Storage::V1::CreateReadSessionRequest.new # (request fields as keyword arguments...)
 response = client.create_read_session request
 ```
 

data/lib/google/cloud/bigquery/storage/v1/big_query_read/client.rb

@@ -44,13 +44,12 @@ module Google
               # See {::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client::Configuration}
               # for a description of the configuration fields.
               #
-              # ## Example
+              # @example
               #
-              # To modify the configuration for all BigQueryRead clients:
-              #
-              #     ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.configure do |config|
-              #       config.timeout = 10.0
-              #     end
+              #   # Modify the configuration for all BigQueryRead clients
+              #   ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.configure do |config|
+              #     config.timeout = 10.0
+              #   end
               #
               # @yield [config] Configure the Client client.
               # @yieldparam config [Client::Configuration]
@@ -70,26 +69,17 @@ module Google
 
                   default_config.rpcs.create_read_session.timeout = 600.0
                   default_config.rpcs.create_read_session.retry_policy = {
-                    initial_delay: 0.1,
-                max_delay: 60.0,
-                multiplier: 1.3,
-                retry_codes: [4, 14]
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                   }
 
                   default_config.rpcs.read_rows.timeout = 86_400.0
                   default_config.rpcs.read_rows.retry_policy = {
-                    initial_delay: 0.1,
-                max_delay: 60.0,
-                multiplier: 1.3,
-                retry_codes: [14]
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                   }
 
                   default_config.rpcs.split_read_stream.timeout = 600.0
                   default_config.rpcs.split_read_stream.retry_policy = {
-                    initial_delay: 0.1,
-                max_delay: 60.0,
-                multiplier: 1.3,
-                retry_codes: [4, 14]
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                   }
 
                   default_config
@@ -121,19 +111,15 @@ module Google
               ##
               # Create a new BigQueryRead client object.
               #
-              # ## Examples
-              #
-              # To create a new BigQueryRead client with the default
-              # configuration:
-              #
-              #     client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
+              # @example
               #
-              # To create a new BigQueryRead client with a custom
-              # configuration:
+              #   # Create a client using the default configuration
+              #   client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
               #
-              #     client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new do |config|
-              #       config.timeout = 10.0
-              #     end
+              #   # Create a client using a custom configuration
+              #   client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new do |config|
+              #     config.timeout = 10.0
+              #   end
               #
               # @yield [config] Configure the BigQueryRead client.
               # @yieldparam config [Client::Configuration]
@@ -153,14 +139,13 @@ module Google
 
                 # Create credentials
                 credentials = @config.credentials
-                # Use self-signed JWT if the scope and endpoint are unchanged from default,
+                # 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.scope == Client.configure.scope &&
-                                         @config.endpoint == Client.configure.endpoint &&
+                enable_self_signed_jwt = @config.endpoint == Client.configure.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)
+                if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                   credentials = Credentials.new credentials, scope: @config.scope
                 end
                 @quota_project_id = @config.quota_project
@@ -195,7 +180,7 @@ module Google
               # limits are enforced based on the number of pre-filtered rows, so some
               # filters can lead to lopsided assignments.
               #
-              # Read sessions automatically expire 24 hours after they are created and do
+              # Read sessions automatically expire 6 hours after they are created and do
               # not require manual clean-up by the caller.
               #
               # @overload create_read_session(request, options = nil)
@@ -262,7 +247,9 @@ module Google
                 options.apply_defaults timeout:      @config.rpcs.create_read_session.timeout,
                                        metadata:     metadata,
                                        retry_policy: @config.rpcs.create_read_session.retry_policy
-                options.apply_defaults metadata:     @config.metadata,
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
                                        retry_policy: @config.retry_policy
 
                 @big_query_read_stub.call_rpc :create_read_session, request, options: options do |response, operation|
@@ -338,7 +325,9 @@ module Google
                 options.apply_defaults timeout:      @config.rpcs.read_rows.timeout,
                                        metadata:     metadata,
                                        retry_policy: @config.rpcs.read_rows.retry_policy
-                options.apply_defaults metadata:     @config.metadata,
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
                                        retry_policy: @config.retry_policy
 
                 @big_query_read_stub.call_rpc :read_rows, request, options: options do |response, operation|
@@ -423,7 +412,9 @@ module Google
                 options.apply_defaults timeout:      @config.rpcs.split_read_stream.timeout,
                                        metadata:     metadata,
                                        retry_policy: @config.rpcs.split_read_stream.retry_policy
-                options.apply_defaults metadata:     @config.metadata,
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
                                        retry_policy: @config.retry_policy
 
                 @big_query_read_stub.call_rpc :split_read_stream, request, options: options do |response, operation|
@@ -447,22 +438,21 @@ module Google
               # Configuration can be applied globally to all clients, or to a single client
               # on construction.
               #
-              # # Examples
-              #
-              # To modify the global config, setting the timeout for create_read_session
-              # to 20 seconds, and all remaining timeouts to 10 seconds:
-              #
-              #     ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.configure do |config|
-              #       config.timeout = 10.0
-              #       config.rpcs.create_read_session.timeout = 20.0
-              #     end
-              #
-              # To apply the above configuration only to a new client:
-              #
-              #     client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new do |config|
-              #       config.timeout = 10.0
-              #       config.rpcs.create_read_session.timeout = 20.0
-              #     end
+              # @example
+              #
+              #   # Modify the global config, setting the timeout for
+              #   # create_read_session to 20 seconds,
+              #   # and all remaining timeouts to 10 seconds.
+              #   ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.configure do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.create_read_session.timeout = 20.0
+              #   end
+              #
+              #   # Apply the above configuration only to a new client.
+              #   client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.create_read_session.timeout = 20.0
+              #   end
               #
               # @!attribute [rw] endpoint
               #   The hostname or hostname:port of the service endpoint.