google-cloud-bigquery-storage-v1 0.1.0

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,247 @@
+# 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
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #    resources:
+    #    - type: "pubsub.googleapis.com/Topic"
+    #      name_descriptor:
+    #        - pattern: "projects/\\{project}/topics/\\{topic}"
+    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #          parent_name_extractor: "projects/\\{project}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         - pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         - pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #
+    # For flexible resources, the resource name doesn't contain parent names, but
+    # the resource itself has parents for policy evaluation.
+    #
+    # Example:
+    #
+    #     message Shelf {
+    #       option (google.api.resource) = {
+    #         type: "library.googleapis.com/Shelf"
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'library.googleapis.com/Shelf'
+    #       name_descriptor:
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    # @!attribute [rw] type
+    #   @return [String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [Array<String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [String]
+    #     The plural name used in the resource name, such as 'projects' for
+    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
+    #     field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    # @!attribute [rw] singular
+    #   @return [String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    class ResourceDescriptor
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #       message ListLogEntriesRequest {
+    #         string parent = 1 [(google.api.resource_reference) = {
+    #           child_type: "logging.googleapis.com/LogEntry"
+    #         };
+    #       }
+    class ResourceReference
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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
+          # Arrow schema as specified in
+          # https://arrow.apache.org/docs/python/api/datatypes.html
+          # and serialized to bytes using IPC:
+          # https://arrow.apache.org/docs/ipc.html.
+          #
+          # See code samples on how this message can be deserialized.
+          # @!attribute [rw] serialized_schema
+          #   @return [String]
+          #     IPC serialized Arrow schema.
+          class ArrowSchema
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Arrow RecordBatch.
+          # @!attribute [rw] serialized_record_batch
+          #   @return [String]
+          #     IPC-serialized Arrow RecordBatch.
+          # @!attribute [rw] row_count
+          #   @return [Integer]
+          #     The count of rows in `serialized_record_batch`.
+          class ArrowRecordBatch
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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
+          # Avro schema.
+          # @!attribute [rw] schema
+          #   @return [String]
+          #     Json serialized schema, as described at
+          #     https://avro.apache.org/docs/1.8.1/spec.html.
+          class AvroSchema
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Avro rows.
+          # @!attribute [rw] serialized_binary_rows
+          #   @return [String]
+          #     Binary serialized rows in a block.
+          # @!attribute [rw] row_count
+          #   @return [Integer]
+          #     The count of rows in the returning block.
+          class AvroRows
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,163 @@
+# 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
+          # Request message for `CreateReadSession`.
+          # @!attribute [rw] parent
+          #   @return [String]
+          #     Required. The request project that owns the session, in the form of
+          #     `projects/{project_id}`.
+          # @!attribute [rw] read_session
+          #   @return [Google::Cloud::Bigquery::Storage::V1::ReadSession]
+          #     Required. Session to be created.
+          # @!attribute [rw] max_stream_count
+          #   @return [Integer]
+          #     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.
+          #
+          #     Streams must be read starting from offset 0.
+          class CreateReadSessionRequest
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for `ReadRows`.
+          # @!attribute [rw] read_stream
+          #   @return [String]
+          #     Required. Stream to read rows from.
+          # @!attribute [rw] offset
+          #   @return [Integer]
+          #     The offset requested must be less than the last row read from Read.
+          #     Requesting a larger offset is undefined. If not specified, start reading
+          #     from offset zero.
+          class ReadRowsRequest
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Information on if the current connection is being throttled.
+          # @!attribute [rw] throttle_percent
+          #   @return [Integer]
+          #     How much this connection is being throttled. Zero means no throttling,
+          #     100 means fully throttled.
+          class ThrottleState
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Estimated stream statistics for a given Stream.
+          # @!attribute [rw] progress
+          #   @return [Google::Cloud::Bigquery::Storage::V1::StreamStats::Progress]
+          #     Represents the progress of the current stream.
+          class StreamStats
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] at_response_start
+            #   @return [Float]
+            #     The fraction of rows assigned to the stream that have been processed by
+            #     the server so far, not including the rows in the current response
+            #     message.
+            #
+            #     This value, along with `at_response_end`, can be used to interpolate
+            #     the progress made as the rows in the message are being processed using
+            #     the following formula: `at_response_start + (at_response_end -
+            #     at_response_start) * rows_processed_from_response / rows_in_response`.
+            #
+            #     Note that if a filter is provided, the `at_response_end` value of the
+            #     previous response may not necessarily be equal to the
+            #     `at_response_start` value of the current response.
+            # @!attribute [rw] at_response_end
+            #   @return [Float]
+            #     Similar to `at_response_start`, except that this value includes the
+            #     rows in the current response.
+            class Progress
+              include Google::Protobuf::MessageExts
+              extend Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Response from calling `ReadRows` may include row data, progress and
+          # throttling information.
+          # @!attribute [rw] avro_rows
+          #   @return [Google::Cloud::Bigquery::Storage::V1::AvroRows]
+          #     Serialized row data in AVRO format.
+          # @!attribute [rw] arrow_record_batch
+          #   @return [Google::Cloud::Bigquery::Storage::V1::ArrowRecordBatch]
+          #     Serialized row data in Arrow RecordBatch format.
+          # @!attribute [rw] row_count
+          #   @return [Integer]
+          #     Number of serialized rows in the rows block.
+          # @!attribute [rw] stats
+          #   @return [Google::Cloud::Bigquery::Storage::V1::StreamStats]
+          #     Statistics for the stream.
+          # @!attribute [rw] throttle_state
+          #   @return [Google::Cloud::Bigquery::Storage::V1::ThrottleState]
+          #     Throttling state. If unset, the latest response still describes
+          #     the current throttling status.
+          class ReadRowsResponse
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for `SplitReadStream`.
+          # @!attribute [rw] name
+          #   @return [String]
+          #     Required. Name of the stream to split.
+          # @!attribute [rw] fraction
+          #   @return [Float]
+          #     A value in the range (0.0, 1.0) that specifies the fractional point at
+          #     which the original stream should be split. The actual split point is
+          #     evaluated on pre-filtered rows, so if a filter is provided, then there is
+          #     no guarantee that the division of the rows between the new child streams
+          #     will be proportional to this fractional value. Additionally, because the
+          #     server-side unit for assigning data is collections of rows, this fraction
+          #     will always map to a data storage boundary on the server side.
+          class SplitReadStreamRequest
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for `SplitReadStream`.
+          # @!attribute [rw] primary_stream
+          #   @return [Google::Cloud::Bigquery::Storage::V1::ReadStream]
+          #     Primary stream, which contains the beginning portion of
+          #     |original_stream|. An empty value indicates that the original stream can no
+          #     longer be split.
+          # @!attribute [rw] remainder_stream
+          #   @return [Google::Cloud::Bigquery::Storage::V1::ReadStream]
+          #     Remainder stream, which contains the tail of |original_stream|. An empty
+          #     value indicates that the original stream can no longer be split.
+          class SplitReadStreamResponse
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end