google-cloud-bigquery-storage-v1 0.12.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97e012ed12b5d17636615b23153be73fd4006ccc47ba0955a722139b09c2f53d
-  data.tar.gz: c2dd5d3b6a99d21fe96e99c2348e578307fbe67c5cd21c829385fdfa89e372df
+  metadata.gz: 0abc8b859be6c644255db082774e841e2489e7b24ed7035cb7471cf9f163fd9c
+  data.tar.gz: f9ee0a03278e1d077608a5ccca9d76083b7fa3ef994e8dd2c0618b6d636105ed
 SHA512:
-  metadata.gz: 40865f1fe1a363798ce1a66aa55f10b450ce09e9aaa6768b0d7c5723901face80a5cec1a4fd09e742e2b8a51f2638fd94bcdb25f650e65758f46612e14ea9fcc
-  data.tar.gz: 9d151f5e6c122112eafca91af8c33d21c01ce03d10895fddca917318300df57c00f2a9c86f9260a10ad5fb37ae02542c3e48d5e73681f1435b59b97b403c247e
+  metadata.gz: ebab73bb11c6015e4fc2912926dd9bb23e746e63eaaa5452db60d5b0a2301ab7437db54e15e2578f35d3b18ac73cac6cde1569e74352bab072e2b8c2e6d1db21
+  data.tar.gz: 7ad7a13d18b4385c8676414e5172fb90a8b8d4d6908bbfdbc48b9a6e4befb0bd2b1c6d8a5d7e8b4fee0d1e39efd8b48f09e92ed6698bf61f4a8664064a5fddd4

data/AUTHENTICATION.md

@@ -114,7 +114,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

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

@@ -12,6 +12,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :serialized_binary_rows, :bytes, 1
       optional :row_count, :int64, 2
     end
+    add_message "google.cloud.bigquery.storage.v1.AvroSerializationOptions" do
+      optional :enable_display_name_attribute, :bool, 1
+    end
   end
 end
 
@@ -22,6 +25,7 @@ module Google
         module V1
           AvroSchema = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.AvroSchema").msgclass
           AvroRows = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.AvroRows").msgclass
+          AvroSerializationOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.AvroSerializationOptions").msgclass
         end
       end
     end

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

@@ -193,7 +193,7 @@ module Google
               #   @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)
+              # @overload create_read_session(parent: nil, read_session: nil, max_stream_count: nil, preferred_min_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).
@@ -214,6 +214,15 @@ module Google
               #     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.
+              #   @param preferred_min_stream_count [::Integer]
+              #     The minimum preferred stream count. This parameter can be used to inform
+              #     the service that there is a desired lower bound on the number of streams.
+              #     This is typically a target parallelism of the client (e.g. a Spark
+              #     cluster with N-workers would set this to a low multiple of N to ensure
+              #     good cluster utilization).
+              #
+              #     The system will make a best effort to provide at least this number of
+              #     streams, but in some cases might provide less.
               #
               # @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

@@ -401,7 +401,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload get_write_stream(name: nil)
+              # @overload get_write_stream(name: nil, view: nil)
               #   Pass arguments to `get_write_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).
@@ -409,6 +409,9 @@ module Google
               #   @param name [::String]
               #     Required. Name of the stream to get, in the form of
               #     `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
+              #   @param view [::Google::Cloud::Bigquery::Storage::V1::WriteStreamView]
+              #     Indicates whether to get full or partial view of the WriteStream. If
+              #     not set, view returned will be basic.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Cloud::Bigquery::Storage::V1::WriteStream]

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

@@ -22,6 +22,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :parent, :string, 1
       optional :read_session, :message, 2, "google.cloud.bigquery.storage.v1.ReadSession"
       optional :max_stream_count, :int32, 3
+      optional :preferred_min_stream_count, :int32, 4
     end
     add_message "google.cloud.bigquery.storage.v1.ReadRowsRequest" do
       optional :read_stream, :string, 1
@@ -77,6 +78,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     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"
+      optional :write_stream, :string, 5
       oneof :response do
         optional :append_result, :message, 1, "google.cloud.bigquery.storage.v1.AppendRowsResponse.AppendResult"
         optional :error, :message, 2, "google.rpc.Status"
@@ -87,6 +89,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.bigquery.storage.v1.GetWriteStreamRequest" do
       optional :name, :string, 1
+      optional :view, :enum, 3, "google.cloud.bigquery.storage.v1.WriteStreamView"
     end
     add_message "google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsRequest" do
       optional :parent, :string, 1

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

@@ -35,6 +35,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :row_restriction, :string, 2
       oneof :output_format_serialization_options do
         optional :arrow_serialization_options, :message, 3, "google.cloud.bigquery.storage.v1.ArrowSerializationOptions"
+        optional :avro_serialization_options, :message, 4, "google.cloud.bigquery.storage.v1.AvroSerializationOptions"
       end
     end
     add_message "google.cloud.bigquery.storage.v1.ReadStream" do
@@ -47,6 +48,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :commit_time, :message, 4, "google.protobuf.Timestamp"
       optional :table_schema, :message, 5, "google.cloud.bigquery.storage.v1.TableSchema"
       optional :write_mode, :enum, 7, "google.cloud.bigquery.storage.v1.WriteStream.WriteMode"
+      optional :location, :string, 8
     end
     add_enum "google.cloud.bigquery.storage.v1.WriteStream.Type" do
       value :TYPE_UNSPECIFIED, 0
@@ -63,6 +65,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :AVRO, 1
       value :ARROW, 2
     end
+    add_enum "google.cloud.bigquery.storage.v1.WriteStreamView" do
+      value :WRITE_STREAM_VIEW_UNSPECIFIED, 0
+      value :BASIC, 1
+      value :FULL, 2
+    end
   end
 end
 
@@ -79,6 +86,7 @@ module Google
           WriteStream::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.WriteStream.Type").enummodule
           WriteStream::WriteMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.WriteStream.WriteMode").enummodule
           DataFormat = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.DataFormat").enummodule
+          WriteStreamView = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.WriteStreamView").enummodule
         end
       end
     end

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

@@ -22,7 +22,7 @@ module Google
     module Bigquery
       module Storage
         module V1
-          VERSION = "0.12.0"
+          VERSION = "0.15.0"
         end
       end
     end

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

@@ -44,6 +44,24 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Contains options specific to Avro Serialization.
+          # @!attribute [rw] enable_display_name_attribute
+          #   @return [::Boolean]
+          #     Enable displayName attribute in Avro schema.
+          #
+          #     The Avro specification requires field names to be alphanumeric.  By
+          #     default, in cases when column names do not conform to these requirements
+          #     (e.g. non-ascii unicode codepoints) and Avro is requested as an output
+          #     format, the CreateReadSession call will fail.
+          #
+          #     Setting this field to true, populates avro field names with a placeholder
+          #     value and populates a "displayName" attribute for every avro field with the
+          #     original column name.
+          class AvroSerializationOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

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

@@ -42,6 +42,16 @@ module Google
           #     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.
+          # @!attribute [rw] preferred_min_stream_count
+          #   @return [::Integer]
+          #     The minimum preferred stream count. This parameter can be used to inform
+          #     the service that there is a desired lower bound on the number of streams.
+          #     This is typically a target parallelism of the client (e.g. a Spark
+          #     cluster with N-workers would set this to a low multiple of N to ensure
+          #     good cluster utilization).
+          #
+          #     The system will make a best effort to provide at least this number of
+          #     streams, but in some cases might provide less.
           class CreateReadSessionRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -183,6 +193,9 @@ module Google
           # Due to the nature of AppendRows being a bidirectional streaming RPC, certain
           # parts of the AppendRowsRequest need only be specified for the first request
           # sent each time the gRPC network connection is opened/reopened.
+          #
+          # The size of a single AppendRowsRequest must be less than 10 MB in size.
+          # Requests larger than this return an error, typically `INVALID_ARGUMENT`.
           # @!attribute [rw] write_stream
           #   @return [::String]
           #     Required. The write_stream identifies the target of the append operation, and only
@@ -269,6 +282,10 @@ module Google
           #     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.
+          # @!attribute [rw] write_stream
+          #   @return [::String]
+          #     The target of the append operation. Matches the write_stream in the
+          #     corresponding request.
           class AppendRowsResponse
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -289,6 +306,10 @@ module Google
           #   @return [::String]
           #     Required. Name of the stream to get, in the form of
           #     `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
+          # @!attribute [rw] view
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::WriteStreamView]
+          #     Indicates whether to get full or partial view of the WriteStream. If
+          #     not set, view returned will be basic.
           class GetWriteStreamRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -88,10 +88,53 @@ module Google
             # Options dictating how we read a table.
             # @!attribute [rw] selected_fields
             #   @return [::Array<::String>]
-            #     Names of the fields in the table that should be read. If empty, all
-            #     fields will be read. If the specified field is a nested field, all
-            #     the sub-fields in the field will be selected. The output field order is
-            #     unrelated to the order of fields in selected_fields.
+            #     Optional. The names of the fields in the table to be returned. If no
+            #     field names are specified, then all fields in the table are returned.
+            #
+            #     Nested fields -- the child elements of a STRUCT field -- can be selected
+            #     individually using their fully-qualified names, and will be returned as
+            #     record fields containing only the selected nested fields. If a STRUCT
+            #     field is specified in the selected fields list, all of the child elements
+            #     will be returned.
+            #
+            #     As an example, consider a table with the following schema:
+            #
+            #       {
+            #           "name": "struct_field",
+            #           "type": "RECORD",
+            #           "mode": "NULLABLE",
+            #           "fields": [
+            #               {
+            #                   "name": "string_field1",
+            #                   "type": "STRING",
+            #     .              "mode": "NULLABLE"
+            #               },
+            #               {
+            #                   "name": "string_field2",
+            #                   "type": "STRING",
+            #                   "mode": "NULLABLE"
+            #               }
+            #           ]
+            #       }
+            #
+            #     Specifying "struct_field" in the selected fields list will result in a
+            #     read session schema with the following logical structure:
+            #
+            #       struct_field {
+            #           string_field1
+            #           string_field2
+            #       }
+            #
+            #     Specifying "struct_field.string_field1" in the selected fields list will
+            #     result in a read session schema with the following logical structure:
+            #
+            #       struct_field {
+            #           string_field1
+            #       }
+            #
+            #     The order of the fields in the read session schema is derived from the
+            #     table schema and does not correspond to the order in which the fields are
+            #     specified in this list.
             # @!attribute [rw] row_restriction
             #   @return [::String]
             #     SQL text filtering statement, similar to a WHERE clause in a query.
@@ -107,6 +150,9 @@ module Google
             # @!attribute [rw] arrow_serialization_options
             #   @return [::Google::Cloud::Bigquery::Storage::V1::ArrowSerializationOptions]
             #     Optional. Options specific to the Apache Arrow output format.
+            # @!attribute [rw] avro_serialization_options
+            #   @return [::Google::Cloud::Bigquery::Storage::V1::AvroSerializationOptions]
+            #     Optional. Options specific to the Apache Avro output format
             class TableReadOptions
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -152,6 +198,11 @@ module Google
           # @!attribute [rw] write_mode
           #   @return [::Google::Cloud::Bigquery::Storage::V1::WriteStream::WriteMode]
           #     Immutable. Mode of the stream.
+          # @!attribute [rw] location
+          #   @return [::String]
+          #     Immutable. The geographic location where the stream's dataset resides. See
+          #     https://cloud.google.com/bigquery/docs/locations for supported
+          #     locations.
           class WriteStream
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -196,6 +247,23 @@ module Google
             # See https://arrow.apache.org/ for more details.
             ARROW = 2
           end
+
+          # WriteStreamView is a view enum that controls what details about a write
+          # stream should be returned.
+          module WriteStreamView
+            # The default / unset value.
+            WRITE_STREAM_VIEW_UNSPECIFIED = 0
+
+            # The BASIC projection returns basic metadata about a write stream.  The
+            # basic view does not include schema information.  This is the default view
+            # returned by GetWriteStream.
+            BASIC = 1
+
+            # The FULL projection returns all available write stream metadata, including
+            # the schema.  CreateWriteStream returns the full projection of write stream
+            # metadata.
+            FULL = 2
+          end
         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.12.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common