google-cloud-bigquery-storage-v1 0.9.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd6247e85a5ffc569f96771fba5c9a3662c25fbd53e6f8e2e9adb7aee9480376
-  data.tar.gz: 0b501022ceac5a5bf209143d5639eb229adaa604d2aeb7b591910642c20e3dd5
+  metadata.gz: 9041851c373718175111413b2e1125660d22bcc2ca78bb0d46bf97ad75866661
+  data.tar.gz: 771714ee33b98b3750ff14a38295b1156c59011ce18fc46664aa54152e798a64
 SHA512:
-  metadata.gz: b0018a10cb61fd33add4559fc6cd7c2323d79dd70244ffdaa0ee45d9ab79ab4139f0563739868c8fcf8be9ee5810a3ecb1378955e992f024a784ca8a0ef7f64c
-  data.tar.gz: 6f45f00046cb5b0723f7bfb214b5e7918ef5ecb151e0f3cc7768a2eeeb9fc1e0f1a4753cd89eb38208dc10552dbeb34bcaae3f49c774b1115c5ad91146935010
+  metadata.gz: 89db88a25bb273beee8ba6dcedae7231c2ee4906a240c1ec2505fbd81e6196bb737879f37150a235cd7e378ef07b4b2a759b317af9a8e365d776d27025a8cfbb
+  data.tar.gz: 5c3f7a8acc54d45b82d2d5786dc08431d7b090f41ed7681f795899d3a747e3a16332aec2f8fcc2090fa1c060cdbbe003fc5c8e78246dd38c18b452c4358ec8b6

data/README.md

@@ -69,6 +69,11 @@ module GRPC
 end
 ```
 
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.5+.

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

@@ -207,11 +207,13 @@ module Google
               #     Max initial number of streams. If unset or zero, the server will
               #     provide a value of streams so as to produce reasonable throughput. Must be
               #     non-negative. The number of streams may be lower than the requested number,
-              #     depending on the amount parallelism that is reasonable for the table. Error
-              #     will be returned if the max count is greater than the current system
-              #     max limit of 1,000.
+              #     depending on the amount parallelism that is reasonable for the table.
+              #     There is a default system max limit of 1,000.
               #
-              #     Streams must be read starting from offset 0.
+              #     This must be greater than or equal to preferred_min_stream_count.
+              #     Typically, clients should either leave this unset to let the system to
+              #     determine an upper bound OR set this a size for the maximum "units of work"
+              #     it can gracefully handle.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Cloud::Bigquery::Storage::V1::ReadSession]

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

@@ -306,6 +306,13 @@ module Google
               # finalized (via the `FinalizeWriteStream` rpc), and the stream is explicitly
               # committed via the `BatchCommitWriteStreams` rpc.
               #
+              # Note: For users coding against the gRPC api directly, it may be
+              # necessary to supply the x-goog-request-params system parameter
+              # with `write_stream=<full_write_stream_name>`.
+              #
+              # More information about system parameters:
+              # https://cloud.google.com/apis/docs/system-parameters
+              #
               # @param request [::Gapic::StreamInput, ::Enumerable<::Google::Cloud::Bigquery::Storage::V1::AppendRowsRequest, ::Hash>]
               #   An enumerable of {::Google::Cloud::Bigquery::Storage::V1::AppendRowsRequest} instances.
               # @param options [::Gapic::CallOptions, ::Hash]

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

@@ -1,9 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/bigquery/storage/v1/protobuf.proto
 
-require 'google/protobuf/descriptor_pb'
 require 'google/protobuf'
 
+require 'google/protobuf/descriptor_pb'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/bigquery/storage/v1/protobuf.proto", :syntax => :proto3) do
     add_message "google.cloud.bigquery.storage.v1.ProtoSchema" do

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

@@ -1,6 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/bigquery/storage/v1/storage.proto
 
+require 'google/protobuf'
+
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -13,7 +15,6 @@ require 'google/cloud/bigquery/storage/v1/table_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf/wrappers_pb'
 require 'google/rpc/status_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/bigquery/storage/v1/storage.proto", :syntax => :proto3) do
@@ -75,6 +76,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.bigquery.storage.v1.AppendRowsResponse" do
       optional :updated_schema, :message, 3, "google.cloud.bigquery.storage.v1.TableSchema"
+      repeated :row_errors, :message, 4, "google.cloud.bigquery.storage.v1.RowError"
       oneof :response do
         optional :append_result, :message, 1, "google.cloud.bigquery.storage.v1.AppendRowsResponse.AppendResult"
         optional :error, :message, 2, "google.rpc.Status"
@@ -121,6 +123,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :INVALID_STREAM_STATE, 5
       value :STREAM_FINALIZED, 6
       value :SCHEMA_MISMATCH_EXTRA_FIELDS, 7
+      value :OFFSET_ALREADY_EXISTS, 8
+      value :OFFSET_OUT_OF_RANGE, 9
+    end
+    add_message "google.cloud.bigquery.storage.v1.RowError" do
+      optional :index, :int64, 1
+      optional :code, :enum, 2, "google.cloud.bigquery.storage.v1.RowError.RowErrorCode"
+      optional :message, :string, 3
+    end
+    add_enum "google.cloud.bigquery.storage.v1.RowError.RowErrorCode" do
+      value :ROW_ERROR_CODE_UNSPECIFIED, 0
+      value :FIELDS_ERROR, 1
     end
   end
 end
@@ -152,6 +165,8 @@ module Google
           FlushRowsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.FlushRowsResponse").msgclass
           StorageError = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.StorageError").msgclass
           StorageError::StorageErrorCode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.StorageError.StorageErrorCode").enummodule
+          RowError = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.RowError").msgclass
+          RowError::RowErrorCode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.RowError.RowErrorCode").enummodule
         end
       end
     end

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

@@ -134,6 +134,13 @@ module Google
               # * For PENDING streams, data is not made visible until the stream itself is
               # finalized (via the `FinalizeWriteStream` rpc), and the stream is explicitly
               # committed via the `BatchCommitWriteStreams` rpc.
+              #
+              # Note: For users coding against the gRPC api directly, it may be
+              # necessary to supply the x-goog-request-params system parameter
+              # with `write_stream=<full_write_stream_name>`.
+              #
+              # More information about system parameters:
+              # https://cloud.google.com/apis/docs/system-parameters
               rpc :AppendRows, stream(::Google::Cloud::Bigquery::Storage::V1::AppendRowsRequest), stream(::Google::Cloud::Bigquery::Storage::V1::AppendRowsResponse)
               # Gets information about a write stream.
               rpc :GetWriteStream, ::Google::Cloud::Bigquery::Storage::V1::GetWriteStreamRequest, ::Google::Cloud::Bigquery::Storage::V1::WriteStream

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

@@ -1,13 +1,14 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/bigquery/storage/v1/stream.proto
 
+require 'google/protobuf'
+
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/bigquery/storage/v1/arrow_pb'
 require 'google/cloud/bigquery/storage/v1/avro_pb'
 require 'google/cloud/bigquery/storage/v1/table_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/bigquery/storage/v1/stream.proto", :syntax => :proto3) do
@@ -20,6 +21,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       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
+      optional :trace_id, :string, 13
       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/table_pb.rb

@@ -1,9 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/bigquery/storage/v1/table.proto
 
-require 'google/api/field_behavior_pb'
 require 'google/protobuf'
 
+require 'google/api/field_behavior_pb'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/bigquery/storage/v1/table.proto", :syntax => :proto3) do
     add_message "google.cloud.bigquery.storage.v1.TableSchema" do

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

@@ -22,7 +22,7 @@ module Google
     module Bigquery
       module Storage
         module V1
-          VERSION = "0.9.2"
+          VERSION = "0.11.0"
         end
       end
     end

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

@@ -27,6 +27,8 @@ module Google
         ##
         # To load this package, including all its services, and instantiate a client:
         #
+        # @example
+        #
         #     require "google/cloud/bigquery/storage/v1"
         #     client = ::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client.new
         #

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

@@ -42,7 +42,8 @@ module Google
           #     IPC-serialized Arrow RecordBatch.
           # @!attribute [rw] row_count
           #   @return [::Integer]
-          #     The count of rows in `serialized_record_batch`.
+          #     [Deprecated] The count of rows in `serialized_record_batch`.
+          #     Please use the format-independent ReadRowsResponse.row_count instead.
           class ArrowRecordBatch
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -38,7 +38,8 @@ module Google
           #     Binary serialized rows in a block.
           # @!attribute [rw] row_count
           #   @return [::Integer]
-          #     The count of rows in the returning block.
+          #     [Deprecated] The count of rows in the returning block.
+          #     Please use the format-independent ReadRowsResponse.row_count instead.
           class AvroRows
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -35,11 +35,13 @@ module Google
           #     Max initial number of streams. If unset or zero, the server will
           #     provide a value of streams so as to produce reasonable throughput. Must be
           #     non-negative. The number of streams may be lower than the requested number,
-          #     depending on the amount parallelism that is reasonable for the table. Error
-          #     will be returned if the max count is greater than the current system
-          #     max limit of 1,000.
+          #     depending on the amount parallelism that is reasonable for the table.
+          #     There is a default system max limit of 1,000.
           #
-          #     Streams must be read starting from offset 0.
+          #     This must be greater than or equal to preferred_min_stream_count.
+          #     Typically, clients should either leave this unset to let the system to
+          #     determine an upper bound OR set this a size for the maximum "units of work"
+          #     it can gracefully handle.
           class CreateReadSessionRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -189,10 +191,12 @@ module Google
           #     request.
           #
           #     For explicitly created write streams, the format is:
-          #     `projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}`
+          #
+          #     * `projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}`
           #
           #     For the special default stream, the format is:
-          #     `projects/{project}/datasets/{dataset}/tables/{table}/_default`.
+          #
+          #     * `projects/{project}/datasets/{dataset}/tables/{table}/streams/_default`.
           # @!attribute [rw] offset
           #   @return [::Google::Protobuf::Int64Value]
           #     If present, the write is only performed if the next append offset is same
@@ -260,6 +264,11 @@ module Google
           #     If backend detects a schema update, pass it to user so that user can
           #     use it to input new type of message. It will be empty when no schema
           #     updates have occurred.
+          # @!attribute [rw] row_errors
+          #   @return [::Array<::Google::Cloud::Bigquery::Storage::V1::RowError>]
+          #     If a request failed due to corrupted rows, no rows in the batch will be
+          #     appended. The API will return row level error info, so that the caller can
+          #     remove the bad rows and retry the request.
           class AppendRowsResponse
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -403,6 +412,36 @@ module Google
               # There is a schema mismatch and it is caused by user schema has extra
               # field than bigquery schema.
               SCHEMA_MISMATCH_EXTRA_FIELDS = 7
+
+              # Offset already exists.
+              OFFSET_ALREADY_EXISTS = 8
+
+              # Offset out of range.
+              OFFSET_OUT_OF_RANGE = 9
+            end
+          end
+
+          # The message that presents row level error info in a request.
+          # @!attribute [rw] index
+          #   @return [::Integer]
+          #     Index of the malformed row in the request.
+          # @!attribute [rw] code
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::RowError::RowErrorCode]
+          #     Structured error reason for a row error.
+          # @!attribute [rw] message
+          #   @return [::String]
+          #     Description of the issue encountered when processing the row.
+          class RowError
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Error code for `RowError`.
+            module RowErrorCode
+              # Default error.
+              ROW_ERROR_CODE_UNSPECIFIED = 0
+
+              # One or more fields in the row has errors.
+              FIELDS_ERROR = 1
             end
           end
         end

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

@@ -34,7 +34,7 @@ module Google
           #     automatically assigned and currently cannot be specified or updated.
           # @!attribute [rw] data_format
           #   @return [::Google::Cloud::Bigquery::Storage::V1::DataFormat]
-          #     Immutable. Data format of the output data.
+          #     Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not supported.
           # @!attribute [r] avro_schema
           #   @return [::Google::Cloud::Bigquery::Storage::V1::AvroSchema]
           #     Output only. Avro schema.
@@ -64,6 +64,14 @@ module Google
           #     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.
+          # @!attribute [rw] trace_id
+          #   @return [::String]
+          #     Optional. ID set by client to annotate a session identity.  This does not need
+          #     to be strictly unique, but instead the same ID should be used to group
+          #     logically connected sessions (e.g. All using the same ID for all sessions
+          #     needed to complete a Spark SQL query is reasonable).
+          #
+          #     Maximum length is 256 bytes.
           class ReadSession
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -177,6 +185,7 @@ module Google
 
           # Data format for input or output data.
           module DataFormat
+            # Data format is unspecified.
             DATA_FORMAT_UNSPECIFIED = 0
 
             # Avro is a standard open source row based file format.

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

@@ -22,7 +22,9 @@ module Google
     module Bigquery
       module Storage
         module V1
-          # Schema of a table.
+          # Schema of a table. This schema is a subset of
+          # google.cloud.bigquery.v2.TableSchema containing information necessary to
+          # generate valid message to write to BigQuery.
           # @!attribute [rw] fields
           #   @return [::Array<::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema>]
           #     Describes the fields in a table.

data/proto_docs/google/protobuf/any.rb

@@ -44,7 +44,7 @@ module Google
     #       foo = any.unpack(Foo.class);
     #     }
     #
-    #  Example 3: Pack and unpack a message in Python.
+    # Example 3: Pack and unpack a message in Python.
     #
     #     foo = Foo(...)
     #     any = Any()
@@ -54,7 +54,7 @@ module Google
     #       any.Unpack(foo)
     #       ...
     #
-    #  Example 4: Pack and unpack a message in Go
+    # Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
     #      any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
     #
     #
     # JSON
-    # ====
+    #
     # The JSON representation of an `Any` value uses the regular
     # representation of the deserialized, embedded message, with an
     # additional field `@type` which contains the type URL. Example:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery-storage-v1
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: API Client library for the BigQuery Storage V1 API