google-cloud-bigquery-migration-v2 0.1.0

data/proto_docs/google/cloud/bigquery/migration/v2/translation_config.rb

@@ -0,0 +1,275 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 Migration
+        module V2
+          # The translation config to capture necessary settings for a translation task
+          # and subtask.
+          # @!attribute [rw] gcs_source_path
+          #   @return [::String]
+          #     The Cloud Storage path for a directory of files to translate in a task.
+          # @!attribute [rw] gcs_target_path
+          #   @return [::String]
+          #     The Cloud Storage path to write back the corresponding input files to.
+          # @!attribute [rw] source_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::Dialect]
+          #     The dialect of the input files.
+          # @!attribute [rw] target_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::Dialect]
+          #     The target dialect for the engine to translate the input to.
+          # @!attribute [rw] name_mapping_list
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::ObjectNameMappingList]
+          #     The mapping of objects to their desired output names in list form.
+          # @!attribute [rw] source_env
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::SourceEnv]
+          #     The default source environment values for the translation.
+          class TranslationConfigDetails
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The possible dialect options for translation.
+          # @!attribute [rw] bigquery_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::BigQueryDialect]
+          #     The BigQuery dialect
+          # @!attribute [rw] hiveql_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::HiveQLDialect]
+          #     The HiveQL dialect
+          # @!attribute [rw] redshift_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::RedshiftDialect]
+          #     The Redshift dialect
+          # @!attribute [rw] teradata_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::TeradataDialect]
+          #     The Teradata dialect
+          # @!attribute [rw] oracle_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::OracleDialect]
+          #     The Oracle dialect
+          # @!attribute [rw] sparksql_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::SparkSQLDialect]
+          #     The SparkSQL dialect
+          # @!attribute [rw] snowflake_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::SnowflakeDialect]
+          #     The Snowflake dialect
+          # @!attribute [rw] netezza_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::NetezzaDialect]
+          #     The Netezza dialect
+          # @!attribute [rw] azure_synapse_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::AzureSynapseDialect]
+          #     The Azure Synapse dialect
+          # @!attribute [rw] vertica_dialect
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::VerticaDialect]
+          #     The Vertica dialect
+          class Dialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The dialect definition for BigQuery.
+          class BigQueryDialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The dialect definition for HiveQL.
+          class HiveQLDialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The dialect definition for Redshift.
+          class RedshiftDialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The dialect definition for Teradata.
+          # @!attribute [rw] mode
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::TeradataDialect::Mode]
+          #     Which Teradata sub-dialect mode the user specifies.
+          class TeradataDialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The sub-dialect options for Teradata.
+            module Mode
+              # Unspecified mode.
+              MODE_UNSPECIFIED = 0
+
+              # Teradata SQL mode.
+              SQL = 1
+
+              # BTEQ mode (which includes SQL).
+              BTEQ = 2
+            end
+          end
+
+          # The dialect definition for Oracle.
+          class OracleDialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The dialect definition for SparkSQL.
+          class SparkSQLDialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The dialect definition for Snowflake.
+          class SnowflakeDialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The dialect definition for Netezza.
+          class NetezzaDialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The dialect definition for Azure Synapse.
+          class AzureSynapseDialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The dialect definition for Vertica.
+          class VerticaDialect
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents a map of name mappings using a list of key:value proto messages of
+          # existing name to desired output name.
+          # @!attribute [rw] name_map
+          #   @return [::Array<::Google::Cloud::Bigquery::Migration::V2::ObjectNameMapping>]
+          #     The elements of the object name map.
+          class ObjectNameMappingList
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents a key-value pair of NameMappingKey to NameMappingValue to
+          # represent the mapping of SQL names from the input value to desired output.
+          # @!attribute [rw] source
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::NameMappingKey]
+          #     The name of the object in source that is being mapped.
+          # @!attribute [rw] target
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::NameMappingValue]
+          #     The desired target name of the object that is being mapped.
+          class ObjectNameMapping
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The potential components of a full name mapping that will be mapped
+          # during translation in the source data warehouse.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Bigquery::Migration::V2::NameMappingKey::Type]
+          #     The type of object that is being mapped.
+          # @!attribute [rw] database
+          #   @return [::String]
+          #     The database name (BigQuery project ID equivalent in the source data
+          #     warehouse).
+          # @!attribute [rw] schema
+          #   @return [::String]
+          #     The schema name (BigQuery dataset equivalent in the source data warehouse).
+          # @!attribute [rw] relation
+          #   @return [::String]
+          #     The relation name (BigQuery table or view equivalent in the source data
+          #     warehouse).
+          # @!attribute [rw] attribute
+          #   @return [::String]
+          #     The attribute name (BigQuery column equivalent in the source data
+          #     warehouse).
+          class NameMappingKey
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of the object that is being mapped.
+            module Type
+              # Unspecified name mapping type.
+              TYPE_UNSPECIFIED = 0
+
+              # The object being mapped is a database.
+              DATABASE = 1
+
+              # The object being mapped is a schema.
+              SCHEMA = 2
+
+              # The object being mapped is a relation.
+              RELATION = 3
+
+              # The object being mapped is an attribute.
+              ATTRIBUTE = 4
+
+              # The object being mapped is a relation alias.
+              RELATION_ALIAS = 5
+
+              # The object being mapped is a an attribute alias.
+              ATTRIBUTE_ALIAS = 6
+
+              # The object being mapped is a function.
+              FUNCTION = 7
+            end
+          end
+
+          # The potential components of a full name mapping that will be mapped
+          # during translation in the target data warehouse.
+          # @!attribute [rw] database
+          #   @return [::String]
+          #     The database name (BigQuery project ID equivalent in the target data
+          #     warehouse).
+          # @!attribute [rw] schema
+          #   @return [::String]
+          #     The schema name (BigQuery dataset equivalent in the target data warehouse).
+          # @!attribute [rw] relation
+          #   @return [::String]
+          #     The relation name (BigQuery table or view equivalent in the target data
+          #     warehouse).
+          # @!attribute [rw] attribute
+          #   @return [::String]
+          #     The attribute name (BigQuery column equivalent in the target data
+          #     warehouse).
+          class NameMappingValue
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents the default source environment values for the translation.
+          # @!attribute [rw] default_database
+          #   @return [::String]
+          #     The default database name to fully qualify SQL objects when their database
+          #     name is missing.
+          # @!attribute [rw] schema_search_path
+          #   @return [::Array<::String>]
+          #     The schema search path. When SQL objects are missing schema name,
+          #     translation engine will search through this list to find the value.
+          class SourceEnv
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/any.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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

data/proto_docs/google/protobuf/duration.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (duration.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/empty.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+    # A generic empty message that you can re-use to avoid defining duplicated
+    # empty messages in your APIs. A typical example is to use it as the request
+    # or the response type of an API method. For instance:
+    #
+    #     service Foo {
+    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+    #     }
+    #
+    # The JSON representation for `Empty` is empty JSON object `{}`.
+    class Empty
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end