google-cloud-bigquery-storage-v1 0.1.0

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

@@ -0,0 +1,55 @@
+# 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!
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module Bigquery
+      module Storage
+        module V1
+          module BigQueryRead
+            # Credentials for the BigQueryRead API.
+            class Credentials < Google::Auth::Credentials
+              self.scope = [
+                "https://www.googleapis.com/auth/bigquery",
+                "https://www.googleapis.com/auth/bigquery.readonly",
+                "https://www.googleapis.com/auth/cloud-platform"
+              ]
+              self.env_vars = [
+                "BIGQUERY_STORAGE_CREDENTIALS",
+                "BIGQUERY_STORAGE_KEYFILE",
+                "GOOGLE_CLOUD_CREDENTIALS",
+                "GOOGLE_CLOUD_KEYFILE",
+                "GCLOUD_KEYFILE",
+                "BIGQUERY_STORAGE_CREDENTIALS_JSON",
+                "BIGQUERY_STORAGE_KEYFILE_JSON",
+                "GOOGLE_CLOUD_CREDENTIALS_JSON",
+                "GOOGLE_CLOUD_KEYFILE_JSON",
+                "GCLOUD_KEYFILE_JSON"
+              ]
+              self.paths = [
+                "~/.config/google_cloud/application_default_credentials.json"
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+# 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!
+
+
+module Google
+  module Cloud
+    module Bigquery
+      module Storage
+        module V1
+          module BigQueryRead
+            # Path helper methods for the BigQueryRead API.
+            module Paths
+              ##
+              # Create a fully-qualified Project resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}`
+              #
+              # @param project [String]
+              #
+              # @return [String]
+              def project_path project:
+                "projects/#{project}"
+              end
+
+              ##
+              # Create a fully-qualified ReadSession resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/locations/{location}/sessions/{session}`
+              #
+              # @param project [String]
+              # @param location [String]
+              # @param session [String]
+              #
+              # @return [String]
+              def read_session_path project:, location:, session:
+                raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                "projects/#{project}/locations/#{location}/sessions/#{session}"
+              end
+
+              ##
+              # Create a fully-qualified ReadStream resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/locations/{location}/sessions/{session}/streams/{stream}`
+              #
+              # @param project [String]
+              # @param location [String]
+              # @param session [String]
+              # @param stream [String]
+              #
+              # @return [String]
+              def read_stream_path project:, location:, session:, stream:
+                raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                raise ArgumentError, "session cannot contain /" if session.to_s.include? "/"
+
+                "projects/#{project}/locations/#{location}/sessions/#{session}/streams/#{stream}"
+              end
+
+              ##
+              # Create a fully-qualified Table resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/datasets/{dataset}/tables/{table}`
+              #
+              # @param project [String]
+              # @param dataset [String]
+              # @param table [String]
+              #
+              # @return [String]
+              def table_path project:, dataset:, table:
+                raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ArgumentError, "dataset cannot contain /" if dataset.to_s.include? "/"
+
+                "projects/#{project}/datasets/#{dataset}/tables/#{table}"
+              end
+
+              extend self
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# 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'
+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/stream_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/bigquery/storage/v1/storage.proto", :syntax => :proto3) do
+    add_message "google.cloud.bigquery.storage.v1.CreateReadSessionRequest" do
+      optional :parent, :string, 1
+      optional :read_session, :message, 2, "google.cloud.bigquery.storage.v1.ReadSession"
+      optional :max_stream_count, :int32, 3
+    end
+    add_message "google.cloud.bigquery.storage.v1.ReadRowsRequest" do
+      optional :read_stream, :string, 1
+      optional :offset, :int64, 2
+    end
+    add_message "google.cloud.bigquery.storage.v1.ThrottleState" do
+      optional :throttle_percent, :int32, 1
+    end
+    add_message "google.cloud.bigquery.storage.v1.StreamStats" do
+      optional :progress, :message, 2, "google.cloud.bigquery.storage.v1.StreamStats.Progress"
+    end
+    add_message "google.cloud.bigquery.storage.v1.StreamStats.Progress" do
+      optional :at_response_start, :double, 1
+      optional :at_response_end, :double, 2
+    end
+    add_message "google.cloud.bigquery.storage.v1.ReadRowsResponse" do
+      optional :row_count, :int64, 6
+      optional :stats, :message, 2, "google.cloud.bigquery.storage.v1.StreamStats"
+      optional :throttle_state, :message, 5, "google.cloud.bigquery.storage.v1.ThrottleState"
+      oneof :rows do
+        optional :avro_rows, :message, 3, "google.cloud.bigquery.storage.v1.AvroRows"
+        optional :arrow_record_batch, :message, 4, "google.cloud.bigquery.storage.v1.ArrowRecordBatch"
+      end
+    end
+    add_message "google.cloud.bigquery.storage.v1.SplitReadStreamRequest" do
+      optional :name, :string, 1
+      optional :fraction, :double, 2
+    end
+    add_message "google.cloud.bigquery.storage.v1.SplitReadStreamResponse" do
+      optional :primary_stream, :message, 1, "google.cloud.bigquery.storage.v1.ReadStream"
+      optional :remainder_stream, :message, 2, "google.cloud.bigquery.storage.v1.ReadStream"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Bigquery
+      module Storage
+        module V1
+          CreateReadSessionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.CreateReadSessionRequest").msgclass
+          ReadRowsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.ReadRowsRequest").msgclass
+          ThrottleState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.ThrottleState").msgclass
+          StreamStats = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.StreamStats").msgclass
+          StreamStats::Progress = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.StreamStats.Progress").msgclass
+          ReadRowsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.ReadRowsResponse").msgclass
+          SplitReadStreamRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.SplitReadStreamRequest").msgclass
+          SplitReadStreamResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.SplitReadStreamResponse").msgclass
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/bigquery/storage/v1/storage.proto for package 'google.cloud.bigquery.storage.v1'
+# Original file comments:
+# Copyright 2019 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
+#
+#     http://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.
+#
+#
+
+require 'grpc'
+require 'google/cloud/bigquery/storage/v1/storage_pb'
+
+module Google
+  module Cloud
+    module Bigquery
+      module Storage
+        module V1
+          module BigQueryRead
+            # BigQuery Read API.
+            #
+            # The Read API can be used to read data from BigQuery.
+            class Service
+
+              include GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.cloud.bigquery.storage.v1.BigQueryRead'
+
+              # 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.
+              rpc :CreateReadSession, CreateReadSessionRequest, ReadSession
+              # 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.
+              rpc :ReadRows, ReadRowsRequest, stream(ReadRowsResponse)
+              # 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.
+              rpc :SplitReadStream, SplitReadStreamRequest, SplitReadStreamResponse
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# 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/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/bigquery/storage/v1/stream.proto", :syntax => :proto3) do
+    add_message "google.cloud.bigquery.storage.v1.ReadSession" do
+      optional :name, :string, 1
+      optional :expire_time, :message, 2, "google.protobuf.Timestamp"
+      optional :data_format, :enum, 3, "google.cloud.bigquery.storage.v1.DataFormat"
+      optional :table, :string, 6
+      optional :table_modifiers, :message, 7, "google.cloud.bigquery.storage.v1.ReadSession.TableModifiers"
+      optional :read_options, :message, 8, "google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions"
+      repeated :streams, :message, 10, "google.cloud.bigquery.storage.v1.ReadStream"
+      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"
+      end
+    end
+    add_message "google.cloud.bigquery.storage.v1.ReadSession.TableModifiers" do
+      optional :snapshot_time, :message, 1, "google.protobuf.Timestamp"
+    end
+    add_message "google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions" do
+      repeated :selected_fields, :string, 1
+      optional :row_restriction, :string, 2
+    end
+    add_message "google.cloud.bigquery.storage.v1.ReadStream" do
+      optional :name, :string, 1
+    end
+    add_enum "google.cloud.bigquery.storage.v1.DataFormat" do
+      value :DATA_FORMAT_UNSPECIFIED, 0
+      value :AVRO, 1
+      value :ARROW, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Bigquery
+      module Storage
+        module V1
+          ReadSession = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.ReadSession").msgclass
+          ReadSession::TableModifiers = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.ReadSession.TableModifiers").msgclass
+          ReadSession::TableReadOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions").msgclass
+          ReadStream = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.ReadStream").msgclass
+          DataFormat = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.storage.v1.DataFormat").enummodule
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# 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!
+
+
+module Google
+  module Cloud
+    module Bigquery
+      module Storage
+        module V1
+          VERSION = "0.1.0"
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/common_resources_pb.rb

@@ -0,0 +1,15 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/common_resources.proto
+
+require 'google/protobuf'
+
+require 'google/api/resource_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/common_resources.proto", :syntax => :proto3) do
+  end
+end
+
+module Google
+  module Cloud
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# BigQuery Storage V1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# 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!
+
+
+module Google
+  module Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end