google-cloud-bigquery-data_transfer 0.1.0

data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/protobuf/struct.rb

@@ -0,0 +1,73 @@
+# Copyright 2018 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.
+
+module Google
+  module Protobuf
+    # +Struct+ represents a structured data value, consisting of fields
+    # which map to dynamically typed values. In some languages, +Struct+
+    # might be supported by a native representation. For example, in
+    # scripting languages like JS a struct is represented as an
+    # object. The details of that representation are described together
+    # with the proto support for the language.
+    #
+    # The JSON representation for +Struct+ is JSON object.
+    # @!attribute [rw] fields
+    #   @return [Hash{String => Google::Protobuf::Value}]
+    #     Unordered map of dynamically typed values.
+    class Struct; end
+
+    # +Value+ represents a dynamically typed value which can be either
+    # null, a number, a string, a boolean, a recursive struct value, or a
+    # list of values. A producer of value is expected to set one of that
+    # variants, absence of any variant indicates an error.
+    #
+    # The JSON representation for +Value+ is JSON value.
+    # @!attribute [rw] null_value
+    #   @return [Google::Protobuf::NullValue]
+    #     Represents a null value.
+    # @!attribute [rw] number_value
+    #   @return [Float]
+    #     Represents a double value.
+    # @!attribute [rw] string_value
+    #   @return [String]
+    #     Represents a string value.
+    # @!attribute [rw] bool_value
+    #   @return [true, false]
+    #     Represents a boolean value.
+    # @!attribute [rw] struct_value
+    #   @return [Google::Protobuf::Struct]
+    #     Represents a structured value.
+    # @!attribute [rw] list_value
+    #   @return [Google::Protobuf::ListValue]
+    #     Represents a repeated +Value+.
+    class Value; end
+
+    # +ListValue+ is a wrapper around a repeated field of values.
+    #
+    # The JSON representation for +ListValue+ is JSON array.
+    # @!attribute [rw] values
+    #   @return [Array<Google::Protobuf::Value>]
+    #     Repeated field of dynamically typed values.
+    class ListValue; end
+
+    # +NullValue+ is a singleton enumeration to represent the null value for the
+    # +Value+ type union.
+    #
+    #  The JSON representation for +NullValue+ is JSON +null+.
+    module NullValue
+      # Null value.
+      NULL_VALUE = 0
+    end
+  end
+end

data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/protobuf/timestamp.rb

@@ -0,0 +1,106 @@
+# Copyright 2018 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.
+
+module Google
+  module Protobuf
+    # A Timestamp represents a point in time independent of any time zone
+    # or calendar, represented as seconds and fractions of seconds at
+    # nanosecond resolution in UTC Epoch time. It is encoded using the
+    # Proleptic Gregorian Calendar which extends the Gregorian calendar
+    # backwards to year one. It is encoded assuming all minutes are 60
+    # seconds long, i.e. leap seconds are "smeared" so that no leap second
+    # table is needed for interpretation. Range is from
+    # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
+    # By restricting to that range, we ensure that we can convert to
+    # and from  RFC 3339 date strings.
+    # See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
+    #
+    # = Examples
+    #
+    # Example 1: Compute Timestamp from POSIX +time()+.
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(time(NULL));
+    #     timestamp.set_nanos(0);
+    #
+    # Example 2: Compute Timestamp from POSIX +gettimeofday()+.
+    #
+    #     struct timeval tv;
+    #     gettimeofday(&tv, NULL);
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(tv.tv_sec);
+    #     timestamp.set_nanos(tv.tv_usec * 1000);
+    #
+    # Example 3: Compute Timestamp from Win32 +GetSystemTimeAsFileTime()+.
+    #
+    #     FILETIME ft;
+    #     GetSystemTimeAsFileTime(&ft);
+    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+    #
+    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+    #
+    # Example 4: Compute Timestamp from Java +System.currentTimeMillis()+.
+    #
+    #     long millis = System.currentTimeMillis();
+    #
+    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
+    #
+    #
+    # Example 5: Compute Timestamp from current time in Python.
+    #
+    #     timestamp = Timestamp()
+    #     timestamp.GetCurrentTime()
+    #
+    # = JSON Mapping
+    #
+    # In JSON format, the Timestamp type is encoded as a string in the
+    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+    # format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
+    # where {year} is always expressed using four digits while {month}, {day},
+    # {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+    # is required, though only UTC (as indicated by "Z") is presently supported.
+    #
+    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+    # 01:30 UTC on January 15, 2017.
+    #
+    # In JavaScript, one can convert a Date object to this format using the
+    # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
+    # method. In Python, a standard +datetime.datetime+ object can be converted
+    # to this format using [+strftime+](https://docs.python.org/2/library/time.html#time.strftime)
+    # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
+    # can use the Joda Time's [+ISODateTimeFormat.dateTime()+](
+    # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime())
+    # to obtain a formatter capable of generating timestamps in this format.
+    # @!attribute [rw] seconds
+    #   @return [Integer]
+    #     Represents seconds of UTC time since Unix epoch
+    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+    #     9999-12-31T23:59:59Z inclusive.
+    # @!attribute [rw] nanos
+    #   @return [Integer]
+    #     Non-negative fractions of a second at nanosecond resolution. Negative
+    #     second values with fractions must still have non-negative nanos values
+    #     that count forward in time. Must be from 0 to 999,999,999
+    #     inclusive.
+    class Timestamp; end
+  end
+end

data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/protobuf/wrappers.rb

@@ -0,0 +1,89 @@
+# Copyright 2018 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.
+
+module Google
+  module Protobuf
+    # Wrapper message for +double+.
+    #
+    # The JSON representation for +DoubleValue+ is JSON number.
+    # @!attribute [rw] value
+    #   @return [Float]
+    #     The double value.
+    class DoubleValue; end
+
+    # Wrapper message for +float+.
+    #
+    # The JSON representation for +FloatValue+ is JSON number.
+    # @!attribute [rw] value
+    #   @return [Float]
+    #     The float value.
+    class FloatValue; end
+
+    # Wrapper message for +int64+.
+    #
+    # The JSON representation for +Int64Value+ is JSON string.
+    # @!attribute [rw] value
+    #   @return [Integer]
+    #     The int64 value.
+    class Int64Value; end
+
+    # Wrapper message for +uint64+.
+    #
+    # The JSON representation for +UInt64Value+ is JSON string.
+    # @!attribute [rw] value
+    #   @return [Integer]
+    #     The uint64 value.
+    class UInt64Value; end
+
+    # Wrapper message for +int32+.
+    #
+    # The JSON representation for +Int32Value+ is JSON number.
+    # @!attribute [rw] value
+    #   @return [Integer]
+    #     The int32 value.
+    class Int32Value; end
+
+    # Wrapper message for +uint32+.
+    #
+    # The JSON representation for +UInt32Value+ is JSON number.
+    # @!attribute [rw] value
+    #   @return [Integer]
+    #     The uint32 value.
+    class UInt32Value; end
+
+    # Wrapper message for +bool+.
+    #
+    # The JSON representation for +BoolValue+ is JSON +true+ and +false+.
+    # @!attribute [rw] value
+    #   @return [true, false]
+    #     The bool value.
+    class BoolValue; end
+
+    # Wrapper message for +string+.
+    #
+    # The JSON representation for +StringValue+ is JSON string.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     The string value.
+    class StringValue; end
+
+    # Wrapper message for +bytes+.
+    #
+    # The JSON representation for +BytesValue+ is JSON string.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     The bytes value.
+    class BytesValue; end
+  end
+end

data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/rpc/status.rb

@@ -0,0 +1,83 @@
+# Copyright 2018 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.
+
+module Google
+  module Rpc
+    # The +Status+ type defines a logical error model that is suitable for different
+    # programming environments, including REST APIs and RPC APIs. It is used by
+    # [gRPC](https://github.com/grpc). The error model is designed to be:
+    #
+    # * Simple to use and understand for most users
+    # * Flexible enough to meet unexpected needs
+    #
+    # = Overview
+    #
+    # The +Status+ message contains three pieces of data: error code, error message,
+    # and error details. The error code should be an enum value of
+    # {Google::Rpc::Code}, but it may accept additional error codes if needed.  The
+    # error message should be a developer-facing English message that helps
+    # developers *understand* and *resolve* the error. If a localized user-facing
+    # error message is needed, put the localized message in the error details or
+    # localize it in the client. The optional error details may contain arbitrary
+    # information about the error. There is a predefined set of error detail types
+    # in the package +google.rpc+ that can be used for common error conditions.
+    #
+    # = Language mapping
+    #
+    # The +Status+ message is the logical representation of the error model, but it
+    # is not necessarily the actual wire format. When the +Status+ message is
+    # exposed in different client libraries and different wire protocols, it can be
+    # mapped differently. For example, it will likely be mapped to some exceptions
+    # in Java, but more likely mapped to some error codes in C.
+    #
+    # = Other uses
+    #
+    # The error model and the +Status+ message can be used in a variety of
+    # environments, either with or without APIs, to provide a
+    # consistent developer experience across different environments.
+    #
+    # Example uses of this error model include:
+    #
+    # * Partial errors. If a service needs to return partial errors to the client,
+    #   it may embed the +Status+ in the normal response to indicate the partial
+    #   errors.
+    #
+    # * Workflow errors. A typical workflow has multiple steps. Each step may
+    #   have a +Status+ message for error reporting.
+    #
+    # * Batch operations. If a client uses batch request and batch response, the
+    #   +Status+ message should be used directly inside batch response, one for
+    #   each error sub-response.
+    #
+    # * Asynchronous operations. If an API call embeds asynchronous operation
+    #   results in its response, the status of those operations should be
+    #   represented directly using the +Status+ message.
+    #
+    # * Logging. If some API errors are stored in logs, the message +Status+ could
+    #   be used directly after any stripping needed for security/privacy reasons.
+    # @!attribute [rw] code
+    #   @return [Integer]
+    #     The status code, which should be an enum value of {Google::Rpc::Code}.
+    # @!attribute [rw] message
+    #   @return [String]
+    #     A developer-facing error message, which should be in English. Any
+    #     user-facing error message should be localized and sent in the
+    #     {Google::Rpc::Status#details} field, or localized by the client.
+    # @!attribute [rw] details
+    #   @return [Array<Google::Protobuf::Any>]
+    #     A list of messages that carry the error details.  There is a common set of
+    #     message types for APIs to use.
+    class Status; end
+  end
+end

data/lib/google/cloud/bigquery/data_transfer/v1/doc/overview.rb

@@ -0,0 +1,79 @@
+# Copyright 2018 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.
+
+module Google
+  module Cloud
+    module Bigquery
+      # rubocop:disable LineLength
+
+      ##
+      # # Ruby Client for BigQuery Data Transfer API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+      #
+      # [BigQuery Data Transfer API][Product Documentation]:
+      # Transfers data from partner SaaS applications to Google BigQuery on a
+      # scheduled, managed basis.
+      # - [Product Documentation][]
+      #
+      # ## Quick Start
+      # In order to use this library, you first need to go through the following
+      # steps:
+      #
+      # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+      # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+      # 3. [Enable the BigQuery Data Transfer API.](https://console.cloud.google.com/apis/api/bigquerydatatransfer)
+      # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+      #
+      # ### Installation
+      # ```
+      # $ gem install google-cloud-bigquery-data_transfer
+      # ```
+      #
+      # ### Preview
+      # #### DataTransferServiceClient
+      # ```rb
+      # require "google/cloud/bigquery/data_transfer"
+      #
+      # data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new
+      # formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_path(project_id)
+      #
+      # # Iterate over all results.
+      # data_transfer_service_client.list_data_sources(formatted_parent).each do |element|
+      #   # Process element.
+      # end
+      #
+      # # Or iterate over results one page at a time.
+      # data_transfer_service_client.list_data_sources(formatted_parent).each_page do |page|
+      #   # Process each page at a time.
+      #   page.each do |element|
+      #     # Process element.
+      #   end
+      # end
+      # ```
+      #
+      # ### Next Steps
+      # - Read the [BigQuery Data Transfer API Product documentation][Product Documentation]
+      #   to learn more about the product and see How-to Guides.
+      # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+      #   to see the full list of Cloud APIs that we cover.
+      #
+      # [Product Documentation]: https://cloud.google.com/bigquerydatatransfer
+      #
+      #
+      module DataTransfer
+        module V1
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/bigquery/data_transfer/v1/transfer_pb.rb

@@ -0,0 +1,82 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/bigquery/datatransfer/v1/transfer.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/protobuf/struct_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/rpc/status_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.cloud.bigquery.datatransfer.v1.TransferConfig" do
+    optional :name, :string, 1
+    optional :destination_dataset_id, :string, 2
+    optional :display_name, :string, 3
+    optional :data_source_id, :string, 5
+    optional :params, :message, 9, "google.protobuf.Struct"
+    optional :schedule, :string, 7
+    optional :data_refresh_window_days, :int32, 12
+    optional :disabled, :bool, 13
+    optional :update_time, :message, 4, "google.protobuf.Timestamp"
+    optional :next_run_time, :message, 8, "google.protobuf.Timestamp"
+    optional :state, :enum, 10, "google.cloud.bigquery.datatransfer.v1.TransferState"
+    optional :user_id, :int64, 11
+    optional :dataset_region, :string, 14
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.TransferRun" do
+    optional :name, :string, 1
+    optional :schedule_time, :message, 3, "google.protobuf.Timestamp"
+    optional :run_time, :message, 10, "google.protobuf.Timestamp"
+    optional :error_status, :message, 21, "google.rpc.Status"
+    optional :start_time, :message, 4, "google.protobuf.Timestamp"
+    optional :end_time, :message, 5, "google.protobuf.Timestamp"
+    optional :update_time, :message, 6, "google.protobuf.Timestamp"
+    optional :params, :message, 9, "google.protobuf.Struct"
+    optional :destination_dataset_id, :string, 2
+    optional :data_source_id, :string, 7
+    optional :state, :enum, 8, "google.cloud.bigquery.datatransfer.v1.TransferState"
+    optional :user_id, :int64, 11
+    optional :schedule, :string, 12
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.TransferMessage" do
+    optional :message_time, :message, 1, "google.protobuf.Timestamp"
+    optional :severity, :enum, 2, "google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity"
+    optional :message_text, :string, 3
+  end
+  add_enum "google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity" do
+    value :MESSAGE_SEVERITY_UNSPECIFIED, 0
+    value :INFO, 1
+    value :WARNING, 2
+    value :ERROR, 3
+  end
+  add_enum "google.cloud.bigquery.datatransfer.v1.TransferType" do
+    value :TRANSFER_TYPE_UNSPECIFIED, 0
+    value :BATCH, 1
+    value :STREAMING, 2
+  end
+  add_enum "google.cloud.bigquery.datatransfer.v1.TransferState" do
+    value :TRANSFER_STATE_UNSPECIFIED, 0
+    value :PENDING, 2
+    value :RUNNING, 3
+    value :SUCCEEDED, 4
+    value :FAILED, 5
+    value :CANCELLED, 6
+  end
+end
+
+module Google
+  module Cloud
+    module Bigquery
+      module DataTransfer
+        module V1
+          TransferConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferConfig").msgclass
+          TransferRun = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferRun").msgclass
+          TransferMessage = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferMessage").msgclass
+          TransferMessage::MessageSeverity = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity").enummodule
+          TransferType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferType").enummodule
+          TransferState = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferState").enummodule
+        end
+      end
+    end
+  end
+end