google-cloud-bigquery-data_transfer-v1 0.1.0

data/proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Bigquery
+      module DataTransfer
+        module V1
+          # Represents preferences for sending email notifications for transfer run
+          # events.
+          # @!attribute [rw] enable_failure_email
+          #   @return [Boolean]
+          #     If true, email notifications will be sent on transfer run failures.
+          class EmailPreferences
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Options customizing the data transfer schedule.
+          # @!attribute [rw] disable_auto_scheduling
+          #   @return [Boolean]
+          #     If true, automatic scheduling of data transfer runs for this configuration
+          #     will be disabled. The runs can be started on ad-hoc basis using
+          #     StartManualTransferRuns API. When automatic scheduling is disabled, the
+          #     TransferConfig.schedule field will be ignored.
+          # @!attribute [rw] start_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Specifies time to start scheduling transfer runs. The first run will be
+          #     scheduled at or after the start time according to a recurrence pattern
+          #     defined in the schedule string. The start time can be changed at any
+          #     moment. The time when a data transfer can be trigerred manually is not
+          #     limited by this option.
+          # @!attribute [rw] end_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Defines time to stop scheduling transfer runs. A transfer run cannot be
+          #     scheduled at or after the end time. The end time can be changed at any
+          #     moment. The time when a data transfer can be trigerred manually is not
+          #     limited by this option.
+          class ScheduleOptions
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # 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 of
+          #     `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
+          #     The name is automatically generated based on the config_id specified in
+          #     CreateTransferConfigRequest along with project_id and region. If config_id
+          #     is not provided, usually a uuid, even though it is not guaranteed or
+          #     required, will be generated for config_id.
+          # @!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] schedule_options
+          #   @return [Google::Cloud::Bigquery::DataTransfer::V1::ScheduleOptions]
+          #     Options customizing the data transfer schedule.
+          # @!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 [Boolean]
+          #     Is this config disabled. When set to true, no runs are scheduled
+          #     for a given transfer.
+          # @!attribute [r] update_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Output only. Data transfer modification time. Ignored by server on input.
+          # @!attribute [r] next_run_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Output only. Next time when data transfer will run.
+          # @!attribute [r] state
+          #   @return [Google::Cloud::Bigquery::DataTransfer::V1::TransferState]
+          #     Output only. State of the most recently updated transfer run.
+          # @!attribute [rw] user_id
+          #   @return [Integer]
+          #     Deprecated. Unique ID of the user on whose behalf transfer is done.
+          # @!attribute [r] dataset_region
+          #   @return [String]
+          #     Output only. Region in which BigQuery dataset is located.
+          # @!attribute [rw] notification_pubsub_topic
+          #   @return [String]
+          #     Pub/Sub topic where notifications will be sent after transfer runs
+          #     associated with this transfer config finish.
+          # @!attribute [rw] email_preferences
+          #   @return [Google::Cloud::Bigquery::DataTransfer::V1::EmailPreferences]
+          #     Email notifications will be sent according to these preferences
+          #     to the email address of the user who owns this transfer config.
+          class TransferConfig
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          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 of the data should be
+          #     ingested.
+          # @!attribute [rw] error_status
+          #   @return [Google::Rpc::Status]
+          #     Status of the transfer run.
+          # @!attribute [r] start_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Output only. Time when transfer run was started.
+          #     Parameter ignored by server for input requests.
+          # @!attribute [r] end_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Output only. Time when transfer run ended.
+          #     Parameter ignored by server for input requests.
+          # @!attribute [r] update_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Output only. Last time the data transfer run state was updated.
+          # @!attribute [r] params
+          #   @return [Google::Protobuf::Struct]
+          #     Output only. Data transfer specific parameters.
+          # @!attribute [r] destination_dataset_id
+          #   @return [String]
+          #     Output only. The BigQuery target dataset id.
+          # @!attribute [r] 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]
+          #     Deprecated. Unique ID of the user on whose behalf transfer is done.
+          # @!attribute [r] 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 match this.
+          # @!attribute [r] notification_pubsub_topic
+          #   @return [String]
+          #     Output only. Pub/Sub topic where a notification will be sent after this
+          #     transfer run finishes
+          # @!attribute [r] email_preferences
+          #   @return [Google::Cloud::Bigquery::DataTransfer::V1::EmailPreferences]
+          #     Output only. Email notifications will be sent according to these
+          #     preferences to the email address of the user who owns the transfer config
+          #     this run was derived from.
+          class TransferRun
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          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
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+
+            # 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 successfully.
+            SUCCEEDED = 4
+
+            # Data transfer failed.
+            FAILED = 5
+
+            # Data transfer is cancelled.
+            CANCELLED = 6
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/any.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module 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 := ptypes.MarshalAny(foo)
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := ptypes.UnmarshalAny(any, 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 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module 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