google-cloud-bigquery-storage-v1 0.6.1 → 0.8.0

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

@@ -69,7 +69,7 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Estimated stream statistics for a given Stream.
+          # Estimated stream statistics for a given read Stream.
           # @!attribute [rw] progress
           #   @return [::Google::Cloud::Bigquery::Storage::V1::StreamStats::Progress]
           #     Represents the progress of the current stream.
@@ -162,6 +162,249 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Request message for `CreateWriteStream`.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. Reference to the table to which the stream belongs, in the format
+          #     of `projects/{project}/datasets/{dataset}/tables/{table}`.
+          # @!attribute [rw] write_stream
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::WriteStream]
+          #     Required. Stream to be created.
+          class CreateWriteStreamRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for `AppendRows`.
+          #
+          # 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.
+          # @!attribute [rw] write_stream
+          #   @return [::String]
+          #     Required. The write_stream identifies the target of the append operation, and only
+          #     needs to be specified as part of the first request on the gRPC connection.
+          #     If provided for subsequent requests, it must match the value of the first
+          #     request.
+          #
+          #     For explicitly created write streams, the format is:
+          #     `projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}`
+          #
+          #     For the special default stream, the format is:
+          #     `projects/{project}/datasets/{dataset}/tables/{table}/_default`.
+          # @!attribute [rw] offset
+          #   @return [::Google::Protobuf::Int64Value]
+          #     If present, the write is only performed if the next append offset is same
+          #     as the provided value. If not present, the write is performed at the
+          #     current end of stream. Specifying a value for this field is not allowed
+          #     when calling AppendRows for the '_default' stream.
+          # @!attribute [rw] proto_rows
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::AppendRowsRequest::ProtoData]
+          #     Rows in proto format.
+          # @!attribute [rw] trace_id
+          #   @return [::String]
+          #     Id set by client to annotate its identity. Only initial request setting is
+          #     respected.
+          class AppendRowsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # ProtoData contains the data rows and schema when constructing append
+            # requests.
+            # @!attribute [rw] writer_schema
+            #   @return [::Google::Cloud::Bigquery::Storage::V1::ProtoSchema]
+            #     Proto schema used to serialize the data.  This value only needs to be
+            #     provided as part of the first request on a gRPC network connection,
+            #     and will be ignored for subsequent requests on the connection.
+            # @!attribute [rw] rows
+            #   @return [::Google::Cloud::Bigquery::Storage::V1::ProtoRows]
+            #     Serialized row data in protobuf message format.
+            #     Currently, the backend expects the serialized rows to adhere to
+            #     proto2 semantics when appending rows, particularly with respect to
+            #     how default values are encoded.
+            class ProtoData
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Response message for `AppendRows`.
+          # @!attribute [rw] append_result
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::AppendRowsResponse::AppendResult]
+          #     Result if the append is successful.
+          # @!attribute [rw] error
+          #   @return [::Google::Rpc::Status]
+          #     Error returned when problems were encountered.  If present,
+          #     it indicates rows were not accepted into the system.
+          #     Users can retry or continue with other append requests within the
+          #     same connection.
+          #
+          #     Additional information about error signalling:
+          #
+          #     ALREADY_EXISTS: Happens when an append specified an offset, and the
+          #     backend already has received data at this offset.  Typically encountered
+          #     in retry scenarios, and can be ignored.
+          #
+          #     OUT_OF_RANGE: Returned when the specified offset in the stream is beyond
+          #     the current end of the stream.
+          #
+          #     INVALID_ARGUMENT: Indicates a malformed request or data.
+          #
+          #     ABORTED: Request processing is aborted because of prior failures.  The
+          #     request can be retried if previous failure is addressed.
+          #
+          #     INTERNAL: Indicates server side error(s) that can be retried.
+          # @!attribute [rw] updated_schema
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::TableSchema]
+          #     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.
+          class AppendRowsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # AppendResult is returned for successful append requests.
+            # @!attribute [rw] offset
+            #   @return [::Google::Protobuf::Int64Value]
+            #     The row offset at which the last append occurred. The offset will not be
+            #     set if appending using default streams.
+            class AppendResult
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Request message for `GetWriteStreamRequest`.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Name of the stream to get, in the form of
+          #     `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
+          class GetWriteStreamRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for `BatchCommitWriteStreams`.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. Parent table that all the streams should belong to, in the form of
+          #     `projects/{project}/datasets/{dataset}/tables/{table}`.
+          # @!attribute [rw] write_streams
+          #   @return [::Array<::String>]
+          #     Required. The group of streams that will be committed atomically.
+          class BatchCommitWriteStreamsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for `BatchCommitWriteStreams`.
+          # @!attribute [rw] commit_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time at which streams were committed in microseconds granularity.
+          #     This field will only exist when there are no stream errors.
+          #     **Note** if this field is not set, it means the commit was not successful.
+          # @!attribute [rw] stream_errors
+          #   @return [::Array<::Google::Cloud::Bigquery::Storage::V1::StorageError>]
+          #     Stream level error if commit failed. Only streams with error will be in
+          #     the list.
+          #     If empty, there is no error and all streams are committed successfully.
+          #     If non empty, certain streams have errors and ZERO stream is committed due
+          #     to atomicity guarantee.
+          class BatchCommitWriteStreamsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for invoking `FinalizeWriteStream`.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Name of the stream to finalize, in the form of
+          #     `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
+          class FinalizeWriteStreamRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for `FinalizeWriteStream`.
+          # @!attribute [rw] row_count
+          #   @return [::Integer]
+          #     Number of rows in the finalized stream.
+          class FinalizeWriteStreamResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for `FlushRows`.
+          # @!attribute [rw] write_stream
+          #   @return [::String]
+          #     Required. The stream that is the target of the flush operation.
+          # @!attribute [rw] offset
+          #   @return [::Google::Protobuf::Int64Value]
+          #     Ending offset of the flush operation. Rows before this offset(including
+          #     this offset) will be flushed.
+          class FlushRowsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Respond message for `FlushRows`.
+          # @!attribute [rw] offset
+          #   @return [::Integer]
+          #     The rows before this offset (including this offset) are flushed.
+          class FlushRowsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Structured custom BigQuery Storage error message. The error can be attached
+          # as error details in the returned rpc Status. In particular, the use of error
+          # codes allows more structured error handling, and reduces the need to evaluate
+          # unstructured error text strings.
+          # @!attribute [rw] code
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::StorageError::StorageErrorCode]
+          #     BigQuery Storage specific error code.
+          # @!attribute [rw] entity
+          #   @return [::String]
+          #     Name of the failed entity.
+          # @!attribute [rw] error_message
+          #   @return [::String]
+          #     Message that describes the error.
+          class StorageError
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Error code for `StorageError`.
+            module StorageErrorCode
+              # Default error.
+              STORAGE_ERROR_CODE_UNSPECIFIED = 0
+
+              # Table is not found in the system.
+              TABLE_NOT_FOUND = 1
+
+              # Stream is already committed.
+              STREAM_ALREADY_COMMITTED = 2
+
+              # Stream is not found.
+              STREAM_NOT_FOUND = 3
+
+              # Invalid Stream type.
+              # For example, you try to commit a stream that is not pending.
+              INVALID_STREAM_TYPE = 4
+
+              # Invalid Stream state.
+              # For example, you try to commit a stream that is not finalized or is
+              # garbaged.
+              INVALID_STREAM_STATE = 5
+
+              # Stream is finalized.
+              STREAM_FINALIZED = 6
+
+              # There is a schema mismatch and it is caused by user schema has extra
+              # field than bigquery schema.
+              SCHEMA_MISMATCH_EXTRA_FIELDS = 7
+            end
+          end
         end
       end
     end

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

@@ -59,6 +59,11 @@ module Google
           #     request_stream_count values *may* result in this list being unpopulated,
           #     in that case, the user will need to use a List method to get the streams
           #     instead, which is not yet available.
+          # @!attribute [r] estimated_total_bytes_scanned
+          #   @return [::Integer]
+          #     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.
           class ReadSession
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -112,6 +117,51 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Information about a single stream that gets data inside the storage system.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. Name of the stream, in the form
+          #     `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::WriteStream::Type]
+          #     Immutable. Type of the stream.
+          # @!attribute [r] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. Create time of the stream. For the _default stream, this is the
+          #     creation_time of the table.
+          # @!attribute [r] commit_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. Commit time of the stream.
+          #     If a stream is of `COMMITTED` type, then it will have a commit_time same as
+          #     `create_time`. If the stream is of `PENDING` type, empty commit_time
+          #     means it is not committed.
+          # @!attribute [r] table_schema
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::TableSchema]
+          #     Output only. The schema of the destination table. It is only returned in
+          #     `CreateWriteStream` response. Caller should generate data that's
+          #     compatible with this schema to send in initial `AppendRowsRequest`.
+          #     The table schema could go out of date during the life time of the stream.
+          class WriteStream
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Type enum of the stream.
+            module Type
+              # Unknown type.
+              TYPE_UNSPECIFIED = 0
+
+              # Data will commit automatically and appear as soon as the write is
+              # acknowledged.
+              COMMITTED = 1
+
+              # Data is invisible until the stream is committed.
+              PENDING = 2
+
+              # Data is only visible up to the offset to which it was flushed.
+              BUFFERED = 3
+            end
+          end
+
           # Data format for input or output data.
           module DataFormat
             DATA_FORMAT_UNSPECIFIED = 0

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

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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
+          # Schema of a table.
+          # @!attribute [rw] fields
+          #   @return [::Array<::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema>]
+          #     Describes the fields in a table.
+          class TableSchema
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # TableFieldSchema defines a single field/column within a table schema.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The field name. The name must contain only letters (a-z, A-Z),
+          #     numbers (0-9), or underscores (_), and must start with a letter or
+          #     underscore. The maximum length is 128 characters.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Type]
+          #     Required. The field data type.
+          # @!attribute [rw] mode
+          #   @return [::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Mode]
+          #     Optional. The field mode. The default value is NULLABLE.
+          # @!attribute [rw] fields
+          #   @return [::Array<::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema>]
+          #     Optional. Describes the nested schema fields if the type property is set to STRUCT.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     Optional. The field description. The maximum length is 1,024 characters.
+          # @!attribute [rw] max_length
+          #   @return [::Integer]
+          #     Optional. Maximum length of values of this field for STRINGS or BYTES.
+          #
+          #     If max_length is not specified, no maximum length constraint is imposed
+          #     on this field.
+          #
+          #     If type = "STRING", then max_length represents the maximum UTF-8
+          #     length of strings in this field.
+          #
+          #     If type = "BYTES", then max_length represents the maximum number of
+          #     bytes in this field.
+          #
+          #     It is invalid to set this field if type is not "STRING" or "BYTES".
+          # @!attribute [rw] precision
+          #   @return [::Integer]
+          #     Optional. Precision (maximum number of total digits in base 10) and scale
+          #     (maximum number of digits in the fractional part in base 10) constraints
+          #     for values of this field for NUMERIC or BIGNUMERIC.
+          #
+          #     It is invalid to set precision or scale if type is not "NUMERIC" or
+          #     "BIGNUMERIC".
+          #
+          #     If precision and scale are not specified, no value range constraint is
+          #     imposed on this field insofar as values are permitted by the type.
+          #
+          #     Values of this NUMERIC or BIGNUMERIC field must be in this range when:
+          #
+          #     * Precision (P) and scale (S) are specified:
+          #       [-10^(P-S) + 10^(-S), 10^(P-S) - 10^(-S)]
+          #     * Precision (P) is specified but not scale (and thus scale is
+          #       interpreted to be equal to zero):
+          #       [-10^P + 1, 10^P - 1].
+          #
+          #     Acceptable values for precision and scale if both are specified:
+          #
+          #     * If type = "NUMERIC":
+          #       1 <= precision - scale <= 29 and 0 <= scale <= 9.
+          #     * If type = "BIGNUMERIC":
+          #       1 <= precision - scale <= 38 and 0 <= scale <= 38.
+          #
+          #     Acceptable values for precision if only precision is specified but not
+          #     scale (and thus scale is interpreted to be equal to zero):
+          #
+          #     * If type = "NUMERIC": 1 <= precision <= 29.
+          #     * If type = "BIGNUMERIC": 1 <= precision <= 38.
+          #
+          #     If scale is specified but not precision, then it is invalid.
+          # @!attribute [rw] scale
+          #   @return [::Integer]
+          #     Optional. See documentation for precision.
+          class TableFieldSchema
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            module Type
+              # Illegal value
+              TYPE_UNSPECIFIED = 0
+
+              # 64K, UTF8
+              STRING = 1
+
+              # 64-bit signed
+              INT64 = 2
+
+              # 64-bit IEEE floating point
+              DOUBLE = 3
+
+              # Aggregate type
+              STRUCT = 4
+
+              # 64K, Binary
+              BYTES = 5
+
+              # 2-valued
+              BOOL = 6
+
+              # 64-bit signed usec since UTC epoch
+              TIMESTAMP = 7
+
+              # Civil date - Year, Month, Day
+              DATE = 8
+
+              # Civil time - Hour, Minute, Second, Microseconds
+              TIME = 9
+
+              # Combination of civil date and civil time
+              DATETIME = 10
+
+              # Geography object
+              GEOGRAPHY = 11
+
+              # Numeric value
+              NUMERIC = 12
+
+              # BigNumeric value
+              BIGNUMERIC = 13
+
+              # Interval
+              INTERVAL = 14
+
+              # JSON, String
+              JSON = 15
+            end
+
+            module Mode
+              # Illegal value
+              MODE_UNSPECIFIED = 0
+
+              NULLABLE = 1
+
+              REQUIRED = 2
+
+              REPEATED = 3
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/any.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Protobuf
+    # `Any` contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := any.UnmarshalTo(foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # 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:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # `value` which holds the custom JSON in addition to the `@type`
+    # field. Example (for message [google.protobuf.Duration][]):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [::String]
+    #     A URL/resource name that uniquely identifies the type of the serialized
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
+    #     the fully qualified name of the type (as in
+    #     `path/google.protobuf.Duration`). The name should be in a canonical form
+    #     (e.g., leading "." is not accepted).
+    #
+    #     In practice, teams usually precompile into the binary all types that they
+    #     expect it to use in the context of Any. However, for URLs which use the
+    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
+    #     server that maps type URLs to message definitions as follows:
+    #
+    #     * If no scheme is provided, `https` is assumed.
+    #     * An HTTP GET on the URL must yield a [google.protobuf.Type][]
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Note: this functionality is not currently available in the official
+    #     protobuf release, and it is not used for type URLs beginning with
+    #     type.googleapis.com.
+    #
+    #     Schemes other than `http`, `https` (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [::String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end