google-cloud-bigquery-storage-v1 0.6.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3ee48f556489873d73de342f983d552d7f613f35581cd047a83561f6a6ab5e6
-  data.tar.gz: dbbab82846fa82748b9bc9a0c020ee1b3d5ad5800f4da8eb67f90bd9658a59cc
+  metadata.gz: ff39be0c1b0dfb6fbab5badfa076d2d9ee567a741fc30c48aa293cbc7ff07f5d
+  data.tar.gz: 66f5972871629dbce68c38fe523fcd28bf8e202f03b6342309fe19921149067d
 SHA512:
-  metadata.gz: fefd9b92ca5b6f42eafbe4768dfbc30429efebfedef044a4291202f99bb85729425a7c322a30598643c07f40c832a0a476cc4a691d2edd449a743416e9a36918
-  data.tar.gz: 94a98be8ec85dd24f7bcfecfd555e6a669b0a3df525341bf5fe56f52eaa222adfb790c680d2894896c547c1faed85b6e7013ae4873c6b6cbb720be0eef143f40
+  metadata.gz: 3606ce4b938d2b6d6e6881cfe3af07c0198eb64d2588561332413f998eef33cb7041d6c95eb1902c703852639a9b1836131c896eae4144cec3cadd37d55a404a
+  data.tar.gz: eda0cb59794e4ef3738688149ac1a8c143f4fac3866ed4f6bb500de8d7636f3ac3bfbdebde96e48df21de4a69b728235f8c64dd23ac88672e44cc441a102cc6f

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]
@@ -112,19 +111,15 @@ module Google
               ##
               # Create a new BigQueryRead client object.
               #
-              # ## Examples
-              #
-              # To create a new BigQueryRead client with the default
-              # configuration:
+              # @example
               #
-              #     client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
+              #   # Create a client using the default configuration
+              #   client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
               #
-              # To create a new BigQueryRead client with a custom
-              # configuration:
-              #
-              #     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]
@@ -144,10 +139,9 @@ 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
@@ -186,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)
@@ -227,6 +221,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/bigquery/storage/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Bigquery::Storage::V1::CreateReadSessionRequest.new
+              #
+              #   # Call the create_read_session method.
+              #   result = client.create_read_session request
+              #
+              #   # The returned object is of type Google::Cloud::Bigquery::Storage::V1::ReadSession.
+              #   p result
+              #
               def create_read_session request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -244,16 +253,20 @@ module Google
                   gapic_version: ::Google::Cloud::Bigquery::Storage::V1::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "read_session.table" => request.read_session.table
-                }
+                header_params = {}
+                if request.read_session&.table
+                  header_params["read_session.table"] = request.read_session.table
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
                 options.apply_defaults timeout:      @config.rpcs.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|
@@ -303,6 +316,24 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/bigquery/storage/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Bigquery::Storage::V1::ReadRowsRequest.new
+              #
+              #   # Call the read_rows method.
+              #   result = client.read_rows request
+              #
+              #   # The returned object is a streamed enumerable yielding elements of
+              #   # type ::Google::Cloud::Bigquery::Storage::V1::ReadRowsResponse.
+              #   result.each do |response|
+              #     p response
+              #   end
+              #
               def read_rows request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -320,16 +351,20 @@ module Google
                   gapic_version: ::Google::Cloud::Bigquery::Storage::V1::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "read_stream" => request.read_stream
-                }
+                header_params = {}
+                if request.read_stream
+                  header_params["read_stream"] = request.read_stream
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
                 options.apply_defaults timeout:      @config.rpcs.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|
@@ -388,6 +423,21 @@ module Google
               #
               # @raise [::Google::Cloud::Error] if the RPC is aborted.
               #
+              # @example Basic example
+              #   require "google/cloud/bigquery/storage/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Bigquery::Storage::V1::SplitReadStreamRequest.new
+              #
+              #   # Call the split_read_stream method.
+              #   result = client.split_read_stream request
+              #
+              #   # The returned object is of type Google::Cloud::Bigquery::Storage::V1::SplitReadStreamResponse.
+              #   p result
+              #
               def split_read_stream request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -405,16 +455,20 @@ module Google
                   gapic_version: ::Google::Cloud::Bigquery::Storage::V1::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "name" => request.name
-                }
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
                 options.apply_defaults timeout:      @config.rpcs.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|
@@ -438,22 +492,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.