google-cloud-bigquery-storage-v1 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b07b9c4f3de0f8ef8bdba56a752c2395a4a8a66994ab61521410b3e99838e3e
-  data.tar.gz: 31cef0791cce88a2ed20e8637c3c5d5e93987483c7e167415fe94f5b3d5f117a
+  metadata.gz: 58a0c1baa01e2035c83e5a26f8a24e2e5019366434cff0d26da8ffbd98f00759
+  data.tar.gz: e29a83123c54d3eee0560d57a671a5773e8bf7611675d919d20b164c6d107f32
 SHA512:
-  metadata.gz: f401af0976b238c8af2303aed67b176c83f9d2f57377e8c242914e883df3b016648203f32aee4be5e93e99cf66d1119d09276d61666883034f3d5e3d98b5b041
-  data.tar.gz: 686ac7ff79abc9a12dd4c2bf617e04982350f9fc66898abd52b944b65183315a36c9f78f8f7a208895ef39ff26e9ac8950914a7c04a959ecc4e4f287822780e2
+  metadata.gz: 381acaf8e118b0825ee281e0be78ed1b803e08faaa4ae98945b5e8718f427f9331f5988abc93895e970357f2634163d50a4631b41c6a2a646bc4f7aba3c5f6d6
+  data.tar.gz: 5e27d722046fbe05e26d1dab20ff58960f29b0f9d6bbf8d2687d8a156bb04ce06d9218a0418fc9e87bc07108d7c198ef336feb16279fe28336acf79250381db8

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.

data/lib/google/cloud/bigquery/storage/v1/storage_services_pb.rb

@@ -30,7 +30,7 @@ module Google
             # The Read API can be used to read data from BigQuery.
             class Service
 
-              include ::GRPC::GenericService
+              include GRPC::GenericService
 
               self.marshal_class_method = :encode
               self.unmarshal_class_method = :decode
@@ -53,7 +53,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.
               rpc :CreateReadSession, ::Google::Cloud::Bigquery::Storage::V1::CreateReadSessionRequest, ::Google::Cloud::Bigquery::Storage::V1::ReadSession
               # Reads rows from the stream in the format prescribed by the ReadSession.

data/lib/google/cloud/bigquery/storage/v1/stream_pb.rb

@@ -18,6 +18,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :table_modifiers, :message, 7, "google.cloud.bigquery.storage.v1.ReadSession.TableModifiers"
       optional :read_options, :message, 8, "google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions"
       repeated :streams, :message, 10, "google.cloud.bigquery.storage.v1.ReadStream"
+      optional :estimated_total_bytes_scanned, :int64, 12
       oneof :schema do
         optional :avro_schema, :message, 4, "google.cloud.bigquery.storage.v1.AvroSchema"
         optional :arrow_schema, :message, 5, "google.cloud.bigquery.storage.v1.ArrowSchema"

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

@@ -22,7 +22,7 @@ module Google
     module Bigquery
       module Storage
         module V1
-          VERSION = "0.6.0"
+          VERSION = "0.7.0"
         end
       end
     end

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

data/proto_docs/google/cloud/bigquery/storage/v1/stream.rb

@@ -59,6 +59,11 @@ module Google
           #     request_stream_count values *may* result in this list being unpopulated,
           #     in that case, the user will need to use a List method to get the streams
           #     instead, which is not yet available.
+          # @!attribute [r] estimated_total_bytes_scanned
+          #   @return [::Integer]
+          #     Output only. An estimate on the number of bytes this session will scan when
+          #     all streams are completely consumed. This estimate is based on
+          #     metadata from the table which might be incomplete or stale.
           class ReadSession
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery-storage-v1
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement