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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a0c1baa01e2035c83e5a26f8a24e2e5019366434cff0d26da8ffbd98f00759
-  data.tar.gz: e29a83123c54d3eee0560d57a671a5773e8bf7611675d919d20b164c6d107f32
+  metadata.gz: a28a465df9bb4bfca7c1b116bd9f5bd0b722c3dd2c7aa7cea30093f185a4ab6f
+  data.tar.gz: e86896e574158ae89908fdb573b8b6dd03b5e0c74d1a11edf3685312794814f8
 SHA512:
-  metadata.gz: 381acaf8e118b0825ee281e0be78ed1b803e08faaa4ae98945b5e8718f427f9331f5988abc93895e970357f2634163d50a4631b41c6a2a646bc4f7aba3c5f6d6
-  data.tar.gz: 5e27d722046fbe05e26d1dab20ff58960f29b0f9d6bbf8d2687d8a156bb04ce06d9218a0418fc9e87bc07108d7c198ef336feb16279fe28336acf79250381db8
+  metadata.gz: 3d89f01e0feb45cccb4c949db695400a84fc63832312128b6d25088a4292380c9afe65048e4ea7bd48aed819ace234365b1e7d4e437ae8f44dc5560f649c5251
+  data.tar.gz: 3362bc84cee06136ba7bfa7e94f4331262230e359dfeac4b2e86711bdc7569901dda7f2b46eafa5f0464927ef46836ac72c87e4e8346a46e960f5fc22f8faf8e

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=BigQuery Storage V1 API
+--title="BigQuery Storage V1 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+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 slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key 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.
 
    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, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   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**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

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

@@ -221,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?
 
@@ -238,9 +253,11 @@ 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
 
@@ -299,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?
 
@@ -316,9 +351,11 @@ 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
 
@@ -386,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?
 
@@ -403,9 +455,11 @@ 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