google-cloud-bigquery-storage-v1 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5340dce2341e9bb36951c0f6ba64d978f589dda8249b75de0ff1d0728c1d9a0
-  data.tar.gz: bd25e1f806d14c8bb4d4b96b30708239b777ea4da77ce8ab9d3c6676daf4cca1
+  metadata.gz: 7337540110b472ba215f9c619a0adaf365f165b5c2925bbdfb1f09643ff20fb6
+  data.tar.gz: f88a1ca2cee278fd0fa21c7902f52498dce2d6b64dbcbad61bff0236d8356d22
 SHA512:
-  metadata.gz: e0c62daed8dde3fe52bd1766ddf621def9919ba426f1bc5604ddd79233c56c876f958f0693051b4e841c3cf0fb24f70809e00e81a32a6a451116e24ce1c9eb42
-  data.tar.gz: ab79ebaa8ddb06888f703ed8aea48b38458c1b51747f28c20e90907c2bccbf75eb796e043c76fc8677e480884b2a80342c5c37f12fa3a57823c4c6ebceaa1200
+  metadata.gz: a6936a74f38e76ec24e8c011fb694e33a790c0f326e49bea2c7ba21df89426bdfd7d0c5cd635ba898b0998065cf3c225da5e0dda7fc6742e4399fa4ebd7efc95
+  data.tar.gz: 47367aede21c530fb8600b7b7ba31b059d50ead93cfce3718edcfd31e3b28e08422aaeab3559bc195c9389f1e0a13983607e4536d6ccfe285c19ccd545a49ec4

data/README.md

@@ -1,4 +1,4 @@
-# BigQuery Storage V1
+# Ruby Client for the BigQuery Storage V1 API
 
 API Client library for the BigQuery Storage V1 API
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
 $ gem install google-cloud-bigquery-storage-v1
 ```
 
+## Before You Begin
+
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/cloud/bigquery/storage/v1"
+
+client = Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
+request = my_create_request
+response = client.create_read_session request
+```
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-bigquery-storage-v1/latest)
+for class and method documentation.
+
+## Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.4+.

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

@@ -1 +1,21 @@
-require "google/cloud/bigquery/storage/v1/version"
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/bigquery/storage/v1"

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

@@ -17,3 +17,21 @@
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
 require "google/cloud/bigquery/storage/v1/big_query_read"
+require "google/cloud/bigquery/storage/v1/version"
+
+module Google
+  module Cloud
+    module Bigquery
+      module Storage
+        ##
+        # To load this package, including all its services, and instantiate a client:
+        #
+        #     require "google/cloud/bigquery/storage/v1"
+        #     client = Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
+        #
+        module V1
+        end
+      end
+    end
+  end
+end

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

@@ -16,5 +16,38 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/bigquery/storage/v1/big_query_read/client"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/bigquery/storage/v1/version"
+
 require "google/cloud/bigquery/storage/v1/big_query_read/credentials"
+require "google/cloud/bigquery/storage/v1/big_query_read/paths"
+require "google/cloud/bigquery/storage/v1/big_query_read/client"
+
+module Google
+  module Cloud
+    module Bigquery
+      module Storage
+        module V1
+          ##
+          # BigQuery Read API.
+          #
+          # The Read API can be used to read data from BigQuery.
+          #
+          # To load this service and instantiate a client:
+          #
+          #     require "google/cloud/bigquery/storage/v1/big_query_read"
+          #     client = Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
+          #
+          module BigQueryRead
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "big_query_read", "helpers.rb"
+require "google/cloud/bigquery/storage/v1/big_query_read/helpers" if ::File.file? helper_path

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

@@ -16,15 +16,8 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 require "google/cloud/errors"
-require "google/cloud/bigquery/storage/v1/version"
 require "google/cloud/bigquery/storage/v1/storage_pb"
-require "google/cloud/bigquery/storage/v1/big_query_read/credentials"
-require "google/cloud/bigquery/storage/v1/big_query_read/paths"
 
 module Google
   module Cloud
@@ -199,34 +192,24 @@ module Google
               # not require manual clean-up by the caller.
               #
               # @overload create_read_session(request, options = nil)
-              #   @param request [Google::Cloud::Bigquery::Storage::V1::CreateReadSessionRequest | Hash]
-              #     Creates a new read session. A read session divides the contents of a
-              #     BigQuery table into one or more streams, which can then be used to read
-              #     data from the table. The read session also specifies properties of the
-              #     data to be read, such as a list of columns or a push-down filter describing
-              #     the rows to be returned.
-              #
-              #     A particular row can be read by at most one stream. When the caller has
-              #     reached the end of each stream in the session, then all the data in the
-              #     table has been read.
-              #
-              #     Data is assigned to each stream such that roughly the same number of
-              #     rows can be read from each stream. Because the server-side unit for
-              #     assigning data is collections of rows, the API does not guarantee that
-              #     each stream will return the same number or rows. Additionally, the
-              #     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
-              #     not require manual clean-up by the caller.
+              #   Pass arguments to `create_read_session` via a request object, either of type
+              #   {Google::Cloud::Bigquery::Storage::V1::CreateReadSessionRequest} or an equivalent Hash.
+              #
+              #   @param request [Google::Cloud::Bigquery::Storage::V1::CreateReadSessionRequest, Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
               #   @param options [Gapic::CallOptions, Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
               # @overload create_read_session(parent: nil, read_session: nil, max_stream_count: nil)
+              #   Pass arguments to `create_read_session` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
               #   @param parent [String]
               #     Required. The request project that owns the session, in the form of
               #     `projects/{project_id}`.
-              #   @param read_session [Google::Cloud::Bigquery::Storage::V1::ReadSession | Hash]
+              #   @param read_session [Google::Cloud::Bigquery::Storage::V1::ReadSession, Hash]
               #     Required. Session to be created.
               #   @param max_stream_count [Integer]
               #     Max initial number of streams. If unset or zero, the server will
@@ -238,7 +221,6 @@ module Google
               #
               #     Streams must be read starting from offset 0.
               #
-              #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [Google::Cloud::Bigquery::Storage::V1::ReadSession]
               # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -294,18 +276,20 @@ module Google
               # state of the stream.
               #
               # @overload read_rows(request, options = nil)
-              #   @param request [Google::Cloud::Bigquery::Storage::V1::ReadRowsRequest | Hash]
-              #     Reads rows from the stream in the format prescribed by the ReadSession.
-              #     Each response contains one or more table rows, up to a maximum of 100 MiB
-              #     per response; read requests which attempt to read individual rows larger
-              #     than 100 MiB will fail.
-              #
-              #     Each request also returns a set of stream statistics reflecting the current
-              #     state of the stream.
+              #   Pass arguments to `read_rows` via a request object, either of type
+              #   {Google::Cloud::Bigquery::Storage::V1::ReadRowsRequest} or an equivalent Hash.
+              #
+              #   @param request [Google::Cloud::Bigquery::Storage::V1::ReadRowsRequest, Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
               #   @param options [Gapic::CallOptions, Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
               # @overload read_rows(read_stream: nil, offset: nil)
+              #   Pass arguments to `read_rows` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
               #   @param read_stream [String]
               #     Required. Stream to read rows from.
               #   @param offset [Integer]
@@ -313,7 +297,6 @@ module Google
               #     Requesting a larger offset is undefined. If not specified, start reading
               #     from offset zero.
               #
-              #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [Enumerable<Google::Cloud::Bigquery::Storage::V1::ReadRowsResponse>]
               # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -374,23 +357,20 @@ module Google
               # completion.
               #
               # @overload split_read_stream(request, options = nil)
-              #   @param request [Google::Cloud::Bigquery::Storage::V1::SplitReadStreamRequest | Hash]
-              #     Splits a given `ReadStream` into two `ReadStream` objects. These
-              #     `ReadStream` objects are referred to as the primary and the residual
-              #     streams of the split. The original `ReadStream` can still be read from in
-              #     the same manner as before. Both of the returned `ReadStream` objects can
-              #     also be read from, and the rows returned by both child streams will be
-              #     the same as the rows read from the original stream.
-              #
-              #     Moreover, the two child streams will be allocated back-to-back in the
-              #     original `ReadStream`. Concretely, it is guaranteed that for streams
-              #     original, primary, and residual, that original[0-j] = primary[0-j] and
-              #     original[j-n] = residual[0-m] once the streams have been read to
-              #     completion.
+              #   Pass arguments to `split_read_stream` via a request object, either of type
+              #   {Google::Cloud::Bigquery::Storage::V1::SplitReadStreamRequest} or an equivalent Hash.
+              #
+              #   @param request [Google::Cloud::Bigquery::Storage::V1::SplitReadStreamRequest, Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
               #   @param options [Gapic::CallOptions, Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
               # @overload split_read_stream(name: nil, fraction: nil)
+              #   Pass arguments to `split_read_stream` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
               #   @param name [String]
               #     Required. Name of the stream to split.
               #   @param fraction [Float]
@@ -402,7 +382,6 @@ module Google
               #     server-side unit for assigning data is collections of rows, this fraction
               #     will always map to a data storage boundary on the server side.
               #
-              #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [Google::Cloud::Bigquery::Storage::V1::SplitReadStreamResponse]
               # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -616,13 +595,3 @@ module Google
     end
   end
 end
-
-# rubocop:disable Lint/HandleExceptions
-
-# Once client is loaded, load helpers.rb if it exists.
-begin
-  require "google/cloud/bigquery/storage/v1/big_query_read/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions

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

@@ -22,7 +22,7 @@ module Google
     module Bigquery
       module Storage
         module V1
-          VERSION = "0.1.2"
+          VERSION = "0.1.3"
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery-storage-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common