google-cloud-bigquery-data_transfer 0.1.0

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

@@ -0,0 +1,216 @@
+# 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.
+          # Next id: 20
+          # @!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.
+          # Next id: 27
+          # @!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
+
+          # 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/any.rb

@@ -0,0 +1,124 @@
+# 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
+    # +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 whose content describes the type of the
+    #     serialized protocol buffer message.
+    #
+    #     For URLs which use the scheme +http+, +https+, or no scheme, the
+    #     following restrictions and interpretations apply:
+    #
+    #     * If no scheme is provided, +https+ is assumed.
+    #     * 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).
+    #     * 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.)
+    #
+    #     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; end
+  end
+end

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

@@ -0,0 +1,90 @@
+# 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 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 (durations.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; end
+  end
+end

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

@@ -0,0 +1,223 @@
+# 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
+    # +FieldMask+ represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here +f+ represents a field in some root message, +a+ and +b+
+    # fields in the message found in +f+, and +d+ a field found in the
+    # message in +f.b+.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # = Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # = Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, the existing
+    # repeated values in the target resource will be overwritten by the new values.
+    # Note that a repeated field is only allowed in the last position of a +paths+
+    # string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then the existing sub-message in the target resource is
+    # overwritten. Given the target message:
+    #
+    #     f {
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       c : 1
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d : 10
+    #       }
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: "f.b"
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d : 10
+    #       }
+    #       c : 1
+    #     }
+    #
+    # However, if the update mask was:
+    #
+    #  paths: "f.b.d"
+    #
+    # then the result would be:
+    #
+    #     f {
+    #       b {
+    #         d : 10
+    #         x : 2
+    #       }
+    #       c : 1
+    #     }
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # == Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # = JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for +Profile+ may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # = Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    # @!attribute [rw] paths
+    #   @return [Array<String>]
+    #     The set of field mask paths.
+    class FieldMask; end
+  end
+end