google-cloud-bigquery-data_transfer 0.1.0 → 0.2.0

data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb

@@ -0,0 +1,214 @@
+# 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
+      module Datatransfer
+        module V1
+          # Represents a data transfer configuration. A transfer configuration
+          # contains all metadata needed to perform a data transfer. For example,
+          # +destination_dataset_id+ specifies where data should be stored.
+          # When a new transfer configuration is created, the specified
+          # +destination_dataset_id+ is created when needed and shared with the
+          # appropriate data source service account.
+          # @!attribute [rw] name
+          #   @return [String]
+          #     The resource name of the transfer config.
+          #     Transfer config names have the form
+          #     +projects/{project_id}/transferConfigs/{config_id}+.
+          #     Where +config_id+ is usually a uuid, even though it is not
+          #     guaranteed or required. The name is ignored when creating a transfer
+          #     config.
+          # @!attribute [rw] destination_dataset_id
+          #   @return [String]
+          #     The BigQuery target dataset id.
+          # @!attribute [rw] display_name
+          #   @return [String]
+          #     User specified display name for the data transfer.
+          # @!attribute [rw] data_source_id
+          #   @return [String]
+          #     Data source id. Cannot be changed once data transfer is created.
+          # @!attribute [rw] params
+          #   @return [Google::Protobuf::Struct]
+          #     Data transfer specific parameters.
+          # @!attribute [rw] schedule
+          #   @return [String]
+          #     Data transfer schedule.
+          #     If the data source does not support a custom schedule, this should be
+          #     empty. If it is empty, the default value for the data source will be
+          #     used.
+          #     The specified times are in UTC.
+          #     Examples of valid format:
+          #     +1st,3rd monday of month 15:30+,
+          #     +every wed,fri of jan,jun 13:15+, and
+          #     +first sunday of quarter 00:00+.
+          #     See more explanation about the format here:
+          #     https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
+          #     NOTE: the granularity should be at least 8 hours, or less frequent.
+          # @!attribute [rw] data_refresh_window_days
+          #   @return [Integer]
+          #     The number of days to look back to automatically refresh the data.
+          #     For example, if +data_refresh_window_days = 10+, then every day
+          #     BigQuery reingests data for [today-10, today-1], rather than ingesting data
+          #     for just [today-1].
+          #     Only valid if the data source supports the feature. Set the value to  0
+          #     to use the default value.
+          # @!attribute [rw] disabled
+          #   @return [true, false]
+          #     Is this config disabled. When set to true, no runs are scheduled
+          #     for a given transfer.
+          # @!attribute [rw] update_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Output only. Data transfer modification time. Ignored by server on input.
+          # @!attribute [rw] next_run_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Output only. Next time when data transfer will run.
+          # @!attribute [rw] state
+          #   @return [Google::Cloud::Bigquery::Datatransfer::V1::TransferState]
+          #     Output only. State of the most recently updated transfer run.
+          # @!attribute [rw] user_id
+          #   @return [Integer]
+          #     Output only. Unique ID of the user on whose behalf transfer is done.
+          #     Applicable only to data sources that do not support service accounts.
+          #     When set to 0, the data source service account credentials are used.
+          #     May be negative. Note, that this identifier is not stable.
+          #     It may change over time even for the same user.
+          # @!attribute [rw] dataset_region
+          #   @return [String]
+          #     Output only. Region in which BigQuery dataset is located.
+          class TransferConfig; end
+
+          # Represents a data transfer run.
+          # @!attribute [rw] name
+          #   @return [String]
+          #     The resource name of the transfer run.
+          #     Transfer run names have the form
+          #     +projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}+.
+          #     The name is ignored when creating a transfer run.
+          # @!attribute [rw] schedule_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Minimum time after which a transfer run can be started.
+          # @!attribute [rw] run_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     For batch transfer runs, specifies the date and time that
+          #     data should be ingested.
+          # @!attribute [rw] error_status
+          #   @return [Google::Rpc::Status]
+          #     Status of the transfer run.
+          # @!attribute [rw] start_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Output only. Time when transfer run was started.
+          #     Parameter ignored by server for input requests.
+          # @!attribute [rw] end_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Output only. Time when transfer run ended.
+          #     Parameter ignored by server for input requests.
+          # @!attribute [rw] update_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Output only. Last time the data transfer run state was updated.
+          # @!attribute [rw] params
+          #   @return [Google::Protobuf::Struct]
+          #     Output only. Data transfer specific parameters.
+          # @!attribute [rw] destination_dataset_id
+          #   @return [String]
+          #     Output only. The BigQuery target dataset id.
+          # @!attribute [rw] data_source_id
+          #   @return [String]
+          #     Output only. Data source id.
+          # @!attribute [rw] state
+          #   @return [Google::Cloud::Bigquery::Datatransfer::V1::TransferState]
+          #     Data transfer run state. Ignored for input requests.
+          # @!attribute [rw] user_id
+          #   @return [Integer]
+          #     Output only. Unique ID of the user on whose behalf transfer is done.
+          #     Applicable only to data sources that do not support service accounts.
+          #     When set to 0, the data source service account credentials are used.
+          #     May be negative. Note, that this identifier is not stable.
+          #     It may change over time even for the same user.
+          # @!attribute [rw] schedule
+          #   @return [String]
+          #     Output only. Describes the schedule of this transfer run if it was
+          #     created as part of a regular schedule. For batch transfer runs that are
+          #     scheduled manually, this is empty.
+          #     NOTE: the system might choose to delay the schedule depending on the
+          #     current load, so +schedule_time+ doesn't always matches this.
+          class TransferRun; end
+
+          # Represents a user facing message for a particular data transfer run.
+          # @!attribute [rw] message_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Time when message was logged.
+          # @!attribute [rw] severity
+          #   @return [Google::Cloud::Bigquery::Datatransfer::V1::TransferMessage::MessageSeverity]
+          #     Message severity.
+          # @!attribute [rw] message_text
+          #   @return [String]
+          #     Message text.
+          class TransferMessage
+            # Represents data transfer user facing message severity.
+            module MessageSeverity
+              # No severity specified.
+              MESSAGE_SEVERITY_UNSPECIFIED = 0
+
+              # Informational message.
+              INFO = 1
+
+              # Warning message.
+              WARNING = 2
+
+              # Error message.
+              ERROR = 3
+            end
+          end
+
+          # DEPRECATED. Represents data transfer type.
+          module TransferType
+            # Invalid or Unknown transfer type placeholder.
+            TRANSFER_TYPE_UNSPECIFIED = 0
+
+            # Batch data transfer.
+            BATCH = 1
+
+            # Streaming data transfer. Streaming data source currently doesn't
+            # support multiple transfer configs per project.
+            STREAMING = 2
+          end
+
+          # Represents data transfer run state.
+          module TransferState
+            # State placeholder.
+            TRANSFER_STATE_UNSPECIFIED = 0
+
+            # Data transfer is scheduled and is waiting to be picked up by
+            # data transfer backend.
+            PENDING = 2
+
+            # Data transfer is in progress.
+            RUNNING = 3
+
+            # Data transfer completed successsfully.
+            SUCCEEDED = 4
+
+            # Data transfer failed.
+            FAILED = 5
+
+            # Data transfer is cancelled.
+            CANCELLED = 6
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# 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 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; end
+  end
+end

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

@@ -69,6 +69,31 @@ module Google
       #
       # [Product Documentation]: https://cloud.google.com/bigquerydatatransfer
       #
+      # ## Enabling Logging
+      #
+      # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+      # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+      # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+      # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+      # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+      #
+      # Configuring a Ruby stdlib logger:
+      #
+      # ```ruby
+      # require "logger"
+      #
+      # module MyLogger
+      #   LOGGER = Logger.new $stderr, level: Logger::WARN
+      #   def logger
+      #     LOGGER
+      #   end
+      # end
+      #
+      # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+      # module GRPC
+      #   extend MyLogger
+      # end
+      # ```
       #
       module DataTransfer
         module V1

data/lib/google/cloud/bigquery/datatransfer/v1/datatransfer_pb.rb

@@ -0,0 +1,189 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/bigquery/datatransfer/v1/datatransfer.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/cloud/bigquery/datatransfer/v1/transfer_pb'
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/protobuf/wrappers_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.cloud.bigquery.datatransfer.v1.DataSourceParameter" do
+    optional :param_id, :string, 1
+    optional :display_name, :string, 2
+    optional :description, :string, 3
+    optional :type, :enum, 4, "google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type"
+    optional :required, :bool, 5
+    optional :repeated, :bool, 6
+    optional :validation_regex, :string, 7
+    repeated :allowed_values, :string, 8
+    optional :min_value, :message, 9, "google.protobuf.DoubleValue"
+    optional :max_value, :message, 10, "google.protobuf.DoubleValue"
+    repeated :fields, :message, 11, "google.cloud.bigquery.datatransfer.v1.DataSourceParameter"
+    optional :validation_description, :string, 12
+    optional :validation_help_url, :string, 13
+    optional :immutable, :bool, 14
+    optional :recurse, :bool, 15
+  end
+  add_enum "google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type" do
+    value :TYPE_UNSPECIFIED, 0
+    value :STRING, 1
+    value :INTEGER, 2
+    value :DOUBLE, 3
+    value :BOOLEAN, 4
+    value :RECORD, 5
+    value :PLUS_PAGE, 6
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.DataSource" do
+    optional :name, :string, 1
+    optional :data_source_id, :string, 2
+    optional :display_name, :string, 3
+    optional :description, :string, 4
+    optional :client_id, :string, 5
+    repeated :scopes, :string, 6
+    optional :transfer_type, :enum, 7, "google.cloud.bigquery.datatransfer.v1.TransferType"
+    optional :supports_multiple_transfers, :bool, 8
+    optional :update_deadline_seconds, :int32, 9
+    optional :default_schedule, :string, 10
+    optional :supports_custom_schedule, :bool, 11
+    repeated :parameters, :message, 12, "google.cloud.bigquery.datatransfer.v1.DataSourceParameter"
+    optional :help_url, :string, 13
+    optional :authorization_type, :enum, 14, "google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType"
+    optional :data_refresh_type, :enum, 15, "google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType"
+    optional :default_data_refresh_window_days, :int32, 16
+    optional :manual_runs_disabled, :bool, 17
+    optional :minimum_schedule_interval, :message, 18, "google.protobuf.Duration"
+  end
+  add_enum "google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType" do
+    value :AUTHORIZATION_TYPE_UNSPECIFIED, 0
+    value :AUTHORIZATION_CODE, 1
+    value :GOOGLE_PLUS_AUTHORIZATION_CODE, 2
+  end
+  add_enum "google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType" do
+    value :DATA_REFRESH_TYPE_UNSPECIFIED, 0
+    value :SLIDING_WINDOW, 1
+    value :CUSTOM_SLIDING_WINDOW, 2
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest" do
+    optional :parent, :string, 1
+    optional :page_token, :string, 3
+    optional :page_size, :int32, 4
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse" do
+    repeated :data_sources, :message, 1, "google.cloud.bigquery.datatransfer.v1.DataSource"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest" do
+    optional :parent, :string, 1
+    optional :transfer_config, :message, 2, "google.cloud.bigquery.datatransfer.v1.TransferConfig"
+    optional :authorization_code, :string, 3
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest" do
+    optional :transfer_config, :message, 1, "google.cloud.bigquery.datatransfer.v1.TransferConfig"
+    optional :authorization_code, :string, 3
+    optional :update_mask, :message, 4, "google.protobuf.FieldMask"
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest" do
+    optional :parent, :string, 1
+    repeated :data_source_ids, :string, 2
+    optional :page_token, :string, 3
+    optional :page_size, :int32, 4
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse" do
+    repeated :transfer_configs, :message, 1, "google.cloud.bigquery.datatransfer.v1.TransferConfig"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest" do
+    optional :parent, :string, 1
+    repeated :states, :enum, 2, "google.cloud.bigquery.datatransfer.v1.TransferState"
+    optional :page_token, :string, 3
+    optional :page_size, :int32, 4
+    optional :run_attempt, :enum, 5, "google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt"
+  end
+  add_enum "google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt" do
+    value :RUN_ATTEMPT_UNSPECIFIED, 0
+    value :LATEST, 1
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse" do
+    repeated :transfer_runs, :message, 1, "google.cloud.bigquery.datatransfer.v1.TransferRun"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest" do
+    optional :parent, :string, 1
+    optional :page_token, :string, 4
+    optional :page_size, :int32, 5
+    repeated :message_types, :enum, 6, "google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity"
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse" do
+    repeated :transfer_messages, :message, 1, "google.cloud.bigquery.datatransfer.v1.TransferMessage"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse" do
+    optional :has_valid_creds, :bool, 1
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest" do
+    optional :parent, :string, 1
+    optional :start_time, :message, 2, "google.protobuf.Timestamp"
+    optional :end_time, :message, 3, "google.protobuf.Timestamp"
+  end
+  add_message "google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse" do
+    repeated :runs, :message, 1, "google.cloud.bigquery.datatransfer.v1.TransferRun"
+  end
+end
+
+module Google
+  module Cloud
+    module Bigquery
+      module Datatransfer
+        module V1
+          DataSourceParameter = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.DataSourceParameter").msgclass
+          DataSourceParameter::Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type").enummodule
+          DataSource = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.DataSource").msgclass
+          DataSource::AuthorizationType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType").enummodule
+          DataSource::DataRefreshType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType").enummodule
+          GetDataSourceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest").msgclass
+          ListDataSourcesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest").msgclass
+          ListDataSourcesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse").msgclass
+          CreateTransferConfigRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest").msgclass
+          UpdateTransferConfigRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest").msgclass
+          GetTransferConfigRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest").msgclass
+          DeleteTransferConfigRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest").msgclass
+          GetTransferRunRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest").msgclass
+          DeleteTransferRunRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest").msgclass
+          ListTransferConfigsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest").msgclass
+          ListTransferConfigsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse").msgclass
+          ListTransferRunsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest").msgclass
+          ListTransferRunsRequest::RunAttempt = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt").enummodule
+          ListTransferRunsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse").msgclass
+          ListTransferLogsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest").msgclass
+          ListTransferLogsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse").msgclass
+          CheckValidCredsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest").msgclass
+          CheckValidCredsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse").msgclass
+          ScheduleTransferRunsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest").msgclass
+          ScheduleTransferRunsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse").msgclass
+        end
+      end
+    end
+  end
+end