google-apis-bigquerydatatransfer_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: a5ef9734dfc5936ba121819b7ced7f6f8ac5f408c267e6b48d7f4ef004c480bd
4
+ data.tar.gz: 68471af2012ddbf3f86743eb470b613e9e598612165758f96d9611135e88f771
5
+ SHA512:
6
+ metadata.gz: 8aa2b7d03207700faf78467fe2807d441036a7521f2d15be7e21281cadd7d615fe83a9849ce47eadcaf6d4ddf266c12d7f0fa3cc65781ddffb497a40a02ba39c
7
+ data.tar.gz: 5a93a3801631c613c88ef703c24ec21f18e91df3809149a07553b26eebb9d6e4d3a85896a03deb1770b5d2e7e28587cf93ed12a0f86a1f928eca66db9dd5f8a8
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-bigquerydatatransfer_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/bigquerydatatransfer_v1/*.rb
9
+ lib/google/apis/bigquerydatatransfer_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-bigquerydatatransfer_v1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20200801
7
+
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1 of the BigQuery Data Transfer API
2
+
3
+ This is a simple client library for version V1 of the BigQuery Data Transfer API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/bigquerydatatransfer.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-bigquerydatatransfer_v1', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-bigquerydatatransfer_v1
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/bigquerydatatransfer_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::BigquerydatatransferV1::BigQueryDataTransferService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Bigquerydatatransfer service in particular.)
67
+
68
+ For reference information on specific calls in the BigQuery Data Transfer API, see the {Google::Apis::BigquerydatatransferV1::BigQueryDataTransferService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-bigquerydatatransfer_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](https://cloud.google.com/bigquery/) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/bigquerydatatransfer_v1"
@@ -0,0 +1,46 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/bigquerydatatransfer_v1/service.rb'
16
+ require 'google/apis/bigquerydatatransfer_v1/classes.rb'
17
+ require 'google/apis/bigquerydatatransfer_v1/representations.rb'
18
+ require 'google/apis/bigquerydatatransfer_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # BigQuery Data Transfer API
23
+ #
24
+ # Schedule queries or transfer external data from SaaS applications to Google
25
+ # BigQuery on a regular basis.
26
+ #
27
+ # @see https://cloud.google.com/bigquery/
28
+ module BigquerydatatransferV1
29
+ # Version of the BigQuery Data Transfer API this client connects to.
30
+ # This is NOT the gem version.
31
+ VERSION = 'V1'
32
+
33
+ # View and manage your data in Google BigQuery
34
+ AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery'
35
+
36
+ # View your data in Google BigQuery
37
+ AUTH_BIGQUERY_READONLY = 'https://www.googleapis.com/auth/bigquery.readonly'
38
+
39
+ # View and manage your data across Google Cloud Platform services
40
+ AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
41
+
42
+ # View your data across Google Cloud Platform services
43
+ AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only'
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,1020 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module BigquerydatatransferV1
24
+
25
+ # A request to determine whether the user has valid credentials. This method is
26
+ # used to limit the number of OAuth popups in the user interface. The user id is
27
+ # inferred from the API call context. If the data source has the Google+
28
+ # authorization type, this method returns false, as it cannot be determined
29
+ # whether the credentials are already valid merely based on the user id.
30
+ class CheckValidCredsRequest
31
+ include Google::Apis::Core::Hashable
32
+
33
+ def initialize(**args)
34
+ update!(**args)
35
+ end
36
+
37
+ # Update properties of this object
38
+ def update!(**args)
39
+ end
40
+ end
41
+
42
+ # A response indicating whether the credentials exist and are valid.
43
+ class CheckValidCredsResponse
44
+ include Google::Apis::Core::Hashable
45
+
46
+ # If set to `true`, the credentials exist and are valid.
47
+ # Corresponds to the JSON property `hasValidCreds`
48
+ # @return [Boolean]
49
+ attr_accessor :has_valid_creds
50
+ alias_method :has_valid_creds?, :has_valid_creds
51
+
52
+ def initialize(**args)
53
+ update!(**args)
54
+ end
55
+
56
+ # Update properties of this object
57
+ def update!(**args)
58
+ @has_valid_creds = args[:has_valid_creds] if args.key?(:has_valid_creds)
59
+ end
60
+ end
61
+
62
+ # Represents data source metadata. Metadata is sufficient to render UI and
63
+ # request proper OAuth tokens.
64
+ class DataSource
65
+ include Google::Apis::Core::Hashable
66
+
67
+ # Indicates the type of authorization.
68
+ # Corresponds to the JSON property `authorizationType`
69
+ # @return [String]
70
+ attr_accessor :authorization_type
71
+
72
+ # Data source client id which should be used to receive refresh token.
73
+ # Corresponds to the JSON property `clientId`
74
+ # @return [String]
75
+ attr_accessor :client_id
76
+
77
+ # Specifies whether the data source supports automatic data refresh for the past
78
+ # few days, and how it's supported. For some data sources, data might not be
79
+ # complete until a few days later, so it's useful to refresh data automatically.
80
+ # Corresponds to the JSON property `dataRefreshType`
81
+ # @return [String]
82
+ attr_accessor :data_refresh_type
83
+
84
+ # Data source id.
85
+ # Corresponds to the JSON property `dataSourceId`
86
+ # @return [String]
87
+ attr_accessor :data_source_id
88
+
89
+ # Default data refresh window on days. Only meaningful when `data_refresh_type` =
90
+ # `SLIDING_WINDOW`.
91
+ # Corresponds to the JSON property `defaultDataRefreshWindowDays`
92
+ # @return [Fixnum]
93
+ attr_accessor :default_data_refresh_window_days
94
+
95
+ # Default data transfer schedule. Examples of valid schedules include: `1st,3rd
96
+ # monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of
97
+ # quarter 00:00`.
98
+ # Corresponds to the JSON property `defaultSchedule`
99
+ # @return [String]
100
+ attr_accessor :default_schedule
101
+
102
+ # User friendly data source description string.
103
+ # Corresponds to the JSON property `description`
104
+ # @return [String]
105
+ attr_accessor :description
106
+
107
+ # User friendly data source name.
108
+ # Corresponds to the JSON property `displayName`
109
+ # @return [String]
110
+ attr_accessor :display_name
111
+
112
+ # Url for the help document for this data source.
113
+ # Corresponds to the JSON property `helpUrl`
114
+ # @return [String]
115
+ attr_accessor :help_url
116
+
117
+ # Disables backfilling and manual run scheduling for the data source.
118
+ # Corresponds to the JSON property `manualRunsDisabled`
119
+ # @return [Boolean]
120
+ attr_accessor :manual_runs_disabled
121
+ alias_method :manual_runs_disabled?, :manual_runs_disabled
122
+
123
+ # The minimum interval for scheduler to schedule runs.
124
+ # Corresponds to the JSON property `minimumScheduleInterval`
125
+ # @return [String]
126
+ attr_accessor :minimum_schedule_interval
127
+
128
+ # Output only. Data source resource name.
129
+ # Corresponds to the JSON property `name`
130
+ # @return [String]
131
+ attr_accessor :name
132
+
133
+ # Data source parameters.
134
+ # Corresponds to the JSON property `parameters`
135
+ # @return [Array<Google::Apis::BigquerydatatransferV1::DataSourceParameter>]
136
+ attr_accessor :parameters
137
+
138
+ # Api auth scopes for which refresh token needs to be obtained. These are scopes
139
+ # needed by a data source to prepare data and ingest them into BigQuery, e.g.,
140
+ # https://www.googleapis.com/auth/bigquery
141
+ # Corresponds to the JSON property `scopes`
142
+ # @return [Array<String>]
143
+ attr_accessor :scopes
144
+
145
+ # Specifies whether the data source supports a user defined schedule, or
146
+ # operates on the default schedule. When set to `true`, user can override
147
+ # default schedule.
148
+ # Corresponds to the JSON property `supportsCustomSchedule`
149
+ # @return [Boolean]
150
+ attr_accessor :supports_custom_schedule
151
+ alias_method :supports_custom_schedule?, :supports_custom_schedule
152
+
153
+ # Deprecated. This field has no effect.
154
+ # Corresponds to the JSON property `supportsMultipleTransfers`
155
+ # @return [Boolean]
156
+ attr_accessor :supports_multiple_transfers
157
+ alias_method :supports_multiple_transfers?, :supports_multiple_transfers
158
+
159
+ # Deprecated. This field has no effect.
160
+ # Corresponds to the JSON property `transferType`
161
+ # @return [String]
162
+ attr_accessor :transfer_type
163
+
164
+ # The number of seconds to wait for an update from the data source before the
165
+ # Data Transfer Service marks the transfer as FAILED.
166
+ # Corresponds to the JSON property `updateDeadlineSeconds`
167
+ # @return [Fixnum]
168
+ attr_accessor :update_deadline_seconds
169
+
170
+ def initialize(**args)
171
+ update!(**args)
172
+ end
173
+
174
+ # Update properties of this object
175
+ def update!(**args)
176
+ @authorization_type = args[:authorization_type] if args.key?(:authorization_type)
177
+ @client_id = args[:client_id] if args.key?(:client_id)
178
+ @data_refresh_type = args[:data_refresh_type] if args.key?(:data_refresh_type)
179
+ @data_source_id = args[:data_source_id] if args.key?(:data_source_id)
180
+ @default_data_refresh_window_days = args[:default_data_refresh_window_days] if args.key?(:default_data_refresh_window_days)
181
+ @default_schedule = args[:default_schedule] if args.key?(:default_schedule)
182
+ @description = args[:description] if args.key?(:description)
183
+ @display_name = args[:display_name] if args.key?(:display_name)
184
+ @help_url = args[:help_url] if args.key?(:help_url)
185
+ @manual_runs_disabled = args[:manual_runs_disabled] if args.key?(:manual_runs_disabled)
186
+ @minimum_schedule_interval = args[:minimum_schedule_interval] if args.key?(:minimum_schedule_interval)
187
+ @name = args[:name] if args.key?(:name)
188
+ @parameters = args[:parameters] if args.key?(:parameters)
189
+ @scopes = args[:scopes] if args.key?(:scopes)
190
+ @supports_custom_schedule = args[:supports_custom_schedule] if args.key?(:supports_custom_schedule)
191
+ @supports_multiple_transfers = args[:supports_multiple_transfers] if args.key?(:supports_multiple_transfers)
192
+ @transfer_type = args[:transfer_type] if args.key?(:transfer_type)
193
+ @update_deadline_seconds = args[:update_deadline_seconds] if args.key?(:update_deadline_seconds)
194
+ end
195
+ end
196
+
197
+ # Represents a data source parameter with validation rules, so that parameters
198
+ # can be rendered in the UI. These parameters are given to us by supported data
199
+ # sources, and include all needed information for rendering and validation. Thus,
200
+ # whoever uses this api can decide to generate either generic ui, or custom
201
+ # data source specific forms.
202
+ class DataSourceParameter
203
+ include Google::Apis::Core::Hashable
204
+
205
+ # All possible values for the parameter.
206
+ # Corresponds to the JSON property `allowedValues`
207
+ # @return [Array<String>]
208
+ attr_accessor :allowed_values
209
+
210
+ # If true, it should not be used in new transfers, and it should not be visible
211
+ # to users.
212
+ # Corresponds to the JSON property `deprecated`
213
+ # @return [Boolean]
214
+ attr_accessor :deprecated
215
+ alias_method :deprecated?, :deprecated
216
+
217
+ # Parameter description.
218
+ # Corresponds to the JSON property `description`
219
+ # @return [String]
220
+ attr_accessor :description
221
+
222
+ # Parameter display name in the user interface.
223
+ # Corresponds to the JSON property `displayName`
224
+ # @return [String]
225
+ attr_accessor :display_name
226
+
227
+ # Deprecated. This field has no effect.
228
+ # Corresponds to the JSON property `fields`
229
+ # @return [Array<Google::Apis::BigquerydatatransferV1::DataSourceParameter>]
230
+ attr_accessor :fields
231
+
232
+ # Cannot be changed after initial creation.
233
+ # Corresponds to the JSON property `immutable`
234
+ # @return [Boolean]
235
+ attr_accessor :immutable
236
+ alias_method :immutable?, :immutable
237
+
238
+ # For integer and double values specifies maxminum allowed value.
239
+ # Corresponds to the JSON property `maxValue`
240
+ # @return [Float]
241
+ attr_accessor :max_value
242
+
243
+ # For integer and double values specifies minimum allowed value.
244
+ # Corresponds to the JSON property `minValue`
245
+ # @return [Float]
246
+ attr_accessor :min_value
247
+
248
+ # Parameter identifier.
249
+ # Corresponds to the JSON property `paramId`
250
+ # @return [String]
251
+ attr_accessor :param_id
252
+
253
+ # Deprecated. This field has no effect.
254
+ # Corresponds to the JSON property `recurse`
255
+ # @return [Boolean]
256
+ attr_accessor :recurse
257
+ alias_method :recurse?, :recurse
258
+
259
+ # Deprecated. This field has no effect.
260
+ # Corresponds to the JSON property `repeated`
261
+ # @return [Boolean]
262
+ attr_accessor :repeated
263
+ alias_method :repeated?, :repeated
264
+
265
+ # Is parameter required.
266
+ # Corresponds to the JSON property `required`
267
+ # @return [Boolean]
268
+ attr_accessor :required
269
+ alias_method :required?, :required
270
+
271
+ # Parameter type.
272
+ # Corresponds to the JSON property `type`
273
+ # @return [String]
274
+ attr_accessor :type
275
+
276
+ # Description of the requirements for this field, in case the user input does
277
+ # not fulfill the regex pattern or min/max values.
278
+ # Corresponds to the JSON property `validationDescription`
279
+ # @return [String]
280
+ attr_accessor :validation_description
281
+
282
+ # URL to a help document to further explain the naming requirements.
283
+ # Corresponds to the JSON property `validationHelpUrl`
284
+ # @return [String]
285
+ attr_accessor :validation_help_url
286
+
287
+ # Regular expression which can be used for parameter validation.
288
+ # Corresponds to the JSON property `validationRegex`
289
+ # @return [String]
290
+ attr_accessor :validation_regex
291
+
292
+ def initialize(**args)
293
+ update!(**args)
294
+ end
295
+
296
+ # Update properties of this object
297
+ def update!(**args)
298
+ @allowed_values = args[:allowed_values] if args.key?(:allowed_values)
299
+ @deprecated = args[:deprecated] if args.key?(:deprecated)
300
+ @description = args[:description] if args.key?(:description)
301
+ @display_name = args[:display_name] if args.key?(:display_name)
302
+ @fields = args[:fields] if args.key?(:fields)
303
+ @immutable = args[:immutable] if args.key?(:immutable)
304
+ @max_value = args[:max_value] if args.key?(:max_value)
305
+ @min_value = args[:min_value] if args.key?(:min_value)
306
+ @param_id = args[:param_id] if args.key?(:param_id)
307
+ @recurse = args[:recurse] if args.key?(:recurse)
308
+ @repeated = args[:repeated] if args.key?(:repeated)
309
+ @required = args[:required] if args.key?(:required)
310
+ @type = args[:type] if args.key?(:type)
311
+ @validation_description = args[:validation_description] if args.key?(:validation_description)
312
+ @validation_help_url = args[:validation_help_url] if args.key?(:validation_help_url)
313
+ @validation_regex = args[:validation_regex] if args.key?(:validation_regex)
314
+ end
315
+ end
316
+
317
+ # Represents preferences for sending email notifications for transfer run events.
318
+ class EmailPreferences
319
+ include Google::Apis::Core::Hashable
320
+
321
+ # If true, email notifications will be sent on transfer run failures.
322
+ # Corresponds to the JSON property `enableFailureEmail`
323
+ # @return [Boolean]
324
+ attr_accessor :enable_failure_email
325
+ alias_method :enable_failure_email?, :enable_failure_email
326
+
327
+ def initialize(**args)
328
+ update!(**args)
329
+ end
330
+
331
+ # Update properties of this object
332
+ def update!(**args)
333
+ @enable_failure_email = args[:enable_failure_email] if args.key?(:enable_failure_email)
334
+ end
335
+ end
336
+
337
+ # A generic empty message that you can re-use to avoid defining duplicated empty
338
+ # messages in your APIs. A typical example is to use it as the request or the
339
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
340
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
341
+ # `Empty` is empty JSON object ````.
342
+ class Empty
343
+ include Google::Apis::Core::Hashable
344
+
345
+ def initialize(**args)
346
+ update!(**args)
347
+ end
348
+
349
+ # Update properties of this object
350
+ def update!(**args)
351
+ end
352
+ end
353
+
354
+ # Returns list of supported data sources and their metadata.
355
+ class ListDataSourcesResponse
356
+ include Google::Apis::Core::Hashable
357
+
358
+ # List of supported data sources and their transfer settings.
359
+ # Corresponds to the JSON property `dataSources`
360
+ # @return [Array<Google::Apis::BigquerydatatransferV1::DataSource>]
361
+ attr_accessor :data_sources
362
+
363
+ # Output only. The next-pagination token. For multiple-page list results, this
364
+ # token can be used as the `ListDataSourcesRequest.page_token` to request the
365
+ # next page of list results.
366
+ # Corresponds to the JSON property `nextPageToken`
367
+ # @return [String]
368
+ attr_accessor :next_page_token
369
+
370
+ def initialize(**args)
371
+ update!(**args)
372
+ end
373
+
374
+ # Update properties of this object
375
+ def update!(**args)
376
+ @data_sources = args[:data_sources] if args.key?(:data_sources)
377
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
378
+ end
379
+ end
380
+
381
+ # The response message for Locations.ListLocations.
382
+ class ListLocationsResponse
383
+ include Google::Apis::Core::Hashable
384
+
385
+ # A list of locations that matches the specified filter in the request.
386
+ # Corresponds to the JSON property `locations`
387
+ # @return [Array<Google::Apis::BigquerydatatransferV1::Location>]
388
+ attr_accessor :locations
389
+
390
+ # The standard List next-page token.
391
+ # Corresponds to the JSON property `nextPageToken`
392
+ # @return [String]
393
+ attr_accessor :next_page_token
394
+
395
+ def initialize(**args)
396
+ update!(**args)
397
+ end
398
+
399
+ # Update properties of this object
400
+ def update!(**args)
401
+ @locations = args[:locations] if args.key?(:locations)
402
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
403
+ end
404
+ end
405
+
406
+ # The returned list of pipelines in the project.
407
+ class ListTransferConfigsResponse
408
+ include Google::Apis::Core::Hashable
409
+
410
+ # Output only. The next-pagination token. For multiple-page list results, this
411
+ # token can be used as the `ListTransferConfigsRequest.page_token` to request
412
+ # the next page of list results.
413
+ # Corresponds to the JSON property `nextPageToken`
414
+ # @return [String]
415
+ attr_accessor :next_page_token
416
+
417
+ # Output only. The stored pipeline transfer configurations.
418
+ # Corresponds to the JSON property `transferConfigs`
419
+ # @return [Array<Google::Apis::BigquerydatatransferV1::TransferConfig>]
420
+ attr_accessor :transfer_configs
421
+
422
+ def initialize(**args)
423
+ update!(**args)
424
+ end
425
+
426
+ # Update properties of this object
427
+ def update!(**args)
428
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
429
+ @transfer_configs = args[:transfer_configs] if args.key?(:transfer_configs)
430
+ end
431
+ end
432
+
433
+ # The returned list transfer run messages.
434
+ class ListTransferLogsResponse
435
+ include Google::Apis::Core::Hashable
436
+
437
+ # Output only. The next-pagination token. For multiple-page list results, this
438
+ # token can be used as the `GetTransferRunLogRequest.page_token` to request the
439
+ # next page of list results.
440
+ # Corresponds to the JSON property `nextPageToken`
441
+ # @return [String]
442
+ attr_accessor :next_page_token
443
+
444
+ # Output only. The stored pipeline transfer messages.
445
+ # Corresponds to the JSON property `transferMessages`
446
+ # @return [Array<Google::Apis::BigquerydatatransferV1::TransferMessage>]
447
+ attr_accessor :transfer_messages
448
+
449
+ def initialize(**args)
450
+ update!(**args)
451
+ end
452
+
453
+ # Update properties of this object
454
+ def update!(**args)
455
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
456
+ @transfer_messages = args[:transfer_messages] if args.key?(:transfer_messages)
457
+ end
458
+ end
459
+
460
+ # The returned list of pipelines in the project.
461
+ class ListTransferRunsResponse
462
+ include Google::Apis::Core::Hashable
463
+
464
+ # Output only. The next-pagination token. For multiple-page list results, this
465
+ # token can be used as the `ListTransferRunsRequest.page_token` to request the
466
+ # next page of list results.
467
+ # Corresponds to the JSON property `nextPageToken`
468
+ # @return [String]
469
+ attr_accessor :next_page_token
470
+
471
+ # Output only. The stored pipeline transfer runs.
472
+ # Corresponds to the JSON property `transferRuns`
473
+ # @return [Array<Google::Apis::BigquerydatatransferV1::TransferRun>]
474
+ attr_accessor :transfer_runs
475
+
476
+ def initialize(**args)
477
+ update!(**args)
478
+ end
479
+
480
+ # Update properties of this object
481
+ def update!(**args)
482
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
483
+ @transfer_runs = args[:transfer_runs] if args.key?(:transfer_runs)
484
+ end
485
+ end
486
+
487
+ # A resource that represents Google Cloud Platform location.
488
+ class Location
489
+ include Google::Apis::Core::Hashable
490
+
491
+ # The friendly name for this location, typically a nearby city name. For example,
492
+ # "Tokyo".
493
+ # Corresponds to the JSON property `displayName`
494
+ # @return [String]
495
+ attr_accessor :display_name
496
+
497
+ # Cross-service attributes for the location. For example `"cloud.googleapis.com/
498
+ # region": "us-east1"`
499
+ # Corresponds to the JSON property `labels`
500
+ # @return [Hash<String,String>]
501
+ attr_accessor :labels
502
+
503
+ # The canonical id for this location. For example: `"us-east1"`.
504
+ # Corresponds to the JSON property `locationId`
505
+ # @return [String]
506
+ attr_accessor :location_id
507
+
508
+ # Service-specific metadata. For example the available capacity at the given
509
+ # location.
510
+ # Corresponds to the JSON property `metadata`
511
+ # @return [Hash<String,Object>]
512
+ attr_accessor :metadata
513
+
514
+ # Resource name for the location, which may vary between implementations. For
515
+ # example: `"projects/example-project/locations/us-east1"`
516
+ # Corresponds to the JSON property `name`
517
+ # @return [String]
518
+ attr_accessor :name
519
+
520
+ def initialize(**args)
521
+ update!(**args)
522
+ end
523
+
524
+ # Update properties of this object
525
+ def update!(**args)
526
+ @display_name = args[:display_name] if args.key?(:display_name)
527
+ @labels = args[:labels] if args.key?(:labels)
528
+ @location_id = args[:location_id] if args.key?(:location_id)
529
+ @metadata = args[:metadata] if args.key?(:metadata)
530
+ @name = args[:name] if args.key?(:name)
531
+ end
532
+ end
533
+
534
+ # Options customizing the data transfer schedule.
535
+ class ScheduleOptions
536
+ include Google::Apis::Core::Hashable
537
+
538
+ # If true, automatic scheduling of data transfer runs for this configuration
539
+ # will be disabled. The runs can be started on ad-hoc basis using
540
+ # StartManualTransferRuns API. When automatic scheduling is disabled, the
541
+ # TransferConfig.schedule field will be ignored.
542
+ # Corresponds to the JSON property `disableAutoScheduling`
543
+ # @return [Boolean]
544
+ attr_accessor :disable_auto_scheduling
545
+ alias_method :disable_auto_scheduling?, :disable_auto_scheduling
546
+
547
+ # Defines time to stop scheduling transfer runs. A transfer run cannot be
548
+ # scheduled at or after the end time. The end time can be changed at any moment.
549
+ # The time when a data transfer can be trigerred manually is not limited by this
550
+ # option.
551
+ # Corresponds to the JSON property `endTime`
552
+ # @return [String]
553
+ attr_accessor :end_time
554
+
555
+ # Specifies time to start scheduling transfer runs. The first run will be
556
+ # scheduled at or after the start time according to a recurrence pattern defined
557
+ # in the schedule string. The start time can be changed at any moment. The time
558
+ # when a data transfer can be trigerred manually is not limited by this option.
559
+ # Corresponds to the JSON property `startTime`
560
+ # @return [String]
561
+ attr_accessor :start_time
562
+
563
+ def initialize(**args)
564
+ update!(**args)
565
+ end
566
+
567
+ # Update properties of this object
568
+ def update!(**args)
569
+ @disable_auto_scheduling = args[:disable_auto_scheduling] if args.key?(:disable_auto_scheduling)
570
+ @end_time = args[:end_time] if args.key?(:end_time)
571
+ @start_time = args[:start_time] if args.key?(:start_time)
572
+ end
573
+ end
574
+
575
+ # A request to schedule transfer runs for a time range.
576
+ class ScheduleTransferRunsRequest
577
+ include Google::Apis::Core::Hashable
578
+
579
+ # Required. End time of the range of transfer runs. For example, `"2017-05-30T00:
580
+ # 00:00+00:00"`.
581
+ # Corresponds to the JSON property `endTime`
582
+ # @return [String]
583
+ attr_accessor :end_time
584
+
585
+ # Required. Start time of the range of transfer runs. For example, `"2017-05-
586
+ # 25T00:00:00+00:00"`.
587
+ # Corresponds to the JSON property `startTime`
588
+ # @return [String]
589
+ attr_accessor :start_time
590
+
591
+ def initialize(**args)
592
+ update!(**args)
593
+ end
594
+
595
+ # Update properties of this object
596
+ def update!(**args)
597
+ @end_time = args[:end_time] if args.key?(:end_time)
598
+ @start_time = args[:start_time] if args.key?(:start_time)
599
+ end
600
+ end
601
+
602
+ # A response to schedule transfer runs for a time range.
603
+ class ScheduleTransferRunsResponse
604
+ include Google::Apis::Core::Hashable
605
+
606
+ # The transfer runs that were scheduled.
607
+ # Corresponds to the JSON property `runs`
608
+ # @return [Array<Google::Apis::BigquerydatatransferV1::TransferRun>]
609
+ attr_accessor :runs
610
+
611
+ def initialize(**args)
612
+ update!(**args)
613
+ end
614
+
615
+ # Update properties of this object
616
+ def update!(**args)
617
+ @runs = args[:runs] if args.key?(:runs)
618
+ end
619
+ end
620
+
621
+ # A request to start manual transfer runs.
622
+ class StartManualTransferRunsRequest
623
+ include Google::Apis::Core::Hashable
624
+
625
+ # Specific run_time for a transfer run to be started. The requested_run_time
626
+ # must not be in the future.
627
+ # Corresponds to the JSON property `requestedRunTime`
628
+ # @return [String]
629
+ attr_accessor :requested_run_time
630
+
631
+ # A specification for a time range, this will request transfer runs with
632
+ # run_time between start_time (inclusive) and end_time (exclusive).
633
+ # Corresponds to the JSON property `requestedTimeRange`
634
+ # @return [Google::Apis::BigquerydatatransferV1::TimeRange]
635
+ attr_accessor :requested_time_range
636
+
637
+ def initialize(**args)
638
+ update!(**args)
639
+ end
640
+
641
+ # Update properties of this object
642
+ def update!(**args)
643
+ @requested_run_time = args[:requested_run_time] if args.key?(:requested_run_time)
644
+ @requested_time_range = args[:requested_time_range] if args.key?(:requested_time_range)
645
+ end
646
+ end
647
+
648
+ # A response to start manual transfer runs.
649
+ class StartManualTransferRunsResponse
650
+ include Google::Apis::Core::Hashable
651
+
652
+ # The transfer runs that were created.
653
+ # Corresponds to the JSON property `runs`
654
+ # @return [Array<Google::Apis::BigquerydatatransferV1::TransferRun>]
655
+ attr_accessor :runs
656
+
657
+ def initialize(**args)
658
+ update!(**args)
659
+ end
660
+
661
+ # Update properties of this object
662
+ def update!(**args)
663
+ @runs = args[:runs] if args.key?(:runs)
664
+ end
665
+ end
666
+
667
+ # The `Status` type defines a logical error model that is suitable for different
668
+ # programming environments, including REST APIs and RPC APIs. It is used by [
669
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
670
+ # data: error code, error message, and error details. You can find out more
671
+ # about this error model and how to work with it in the [API Design Guide](https:
672
+ # //cloud.google.com/apis/design/errors).
673
+ class Status
674
+ include Google::Apis::Core::Hashable
675
+
676
+ # The status code, which should be an enum value of google.rpc.Code.
677
+ # Corresponds to the JSON property `code`
678
+ # @return [Fixnum]
679
+ attr_accessor :code
680
+
681
+ # A list of messages that carry the error details. There is a common set of
682
+ # message types for APIs to use.
683
+ # Corresponds to the JSON property `details`
684
+ # @return [Array<Hash<String,Object>>]
685
+ attr_accessor :details
686
+
687
+ # A developer-facing error message, which should be in English. Any user-facing
688
+ # error message should be localized and sent in the google.rpc.Status.details
689
+ # field, or localized by the client.
690
+ # Corresponds to the JSON property `message`
691
+ # @return [String]
692
+ attr_accessor :message
693
+
694
+ def initialize(**args)
695
+ update!(**args)
696
+ end
697
+
698
+ # Update properties of this object
699
+ def update!(**args)
700
+ @code = args[:code] if args.key?(:code)
701
+ @details = args[:details] if args.key?(:details)
702
+ @message = args[:message] if args.key?(:message)
703
+ end
704
+ end
705
+
706
+ # A specification for a time range, this will request transfer runs with
707
+ # run_time between start_time (inclusive) and end_time (exclusive).
708
+ class TimeRange
709
+ include Google::Apis::Core::Hashable
710
+
711
+ # End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:
712
+ # 00"`. The end_time must not be in the future. Creates transfer runs where
713
+ # run_time is in the range between start_time (inclusive) and end_time (
714
+ # exclusive).
715
+ # Corresponds to the JSON property `endTime`
716
+ # @return [String]
717
+ attr_accessor :end_time
718
+
719
+ # Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+
720
+ # 00:00"`. The start_time must be strictly less than the end_time. Creates
721
+ # transfer runs where run_time is in the range between start_time (inclusive)
722
+ # and end_time (exclusive).
723
+ # Corresponds to the JSON property `startTime`
724
+ # @return [String]
725
+ attr_accessor :start_time
726
+
727
+ def initialize(**args)
728
+ update!(**args)
729
+ end
730
+
731
+ # Update properties of this object
732
+ def update!(**args)
733
+ @end_time = args[:end_time] if args.key?(:end_time)
734
+ @start_time = args[:start_time] if args.key?(:start_time)
735
+ end
736
+ end
737
+
738
+ # Represents a data transfer configuration. A transfer configuration contains
739
+ # all metadata needed to perform a data transfer. For example, `
740
+ # destination_dataset_id` specifies where data should be stored. When a new
741
+ # transfer configuration is created, the specified `destination_dataset_id` is
742
+ # created when needed and shared with the appropriate data source service
743
+ # account.
744
+ class TransferConfig
745
+ include Google::Apis::Core::Hashable
746
+
747
+ # The number of days to look back to automatically refresh the data. For example,
748
+ # if `data_refresh_window_days = 10`, then every day BigQuery reingests data
749
+ # for [today-10, today-1], rather than ingesting data for just [today-1]. Only
750
+ # valid if the data source supports the feature. Set the value to 0 to use the
751
+ # default value.
752
+ # Corresponds to the JSON property `dataRefreshWindowDays`
753
+ # @return [Fixnum]
754
+ attr_accessor :data_refresh_window_days
755
+
756
+ # Data source id. Cannot be changed once data transfer is created.
757
+ # Corresponds to the JSON property `dataSourceId`
758
+ # @return [String]
759
+ attr_accessor :data_source_id
760
+
761
+ # Output only. Region in which BigQuery dataset is located.
762
+ # Corresponds to the JSON property `datasetRegion`
763
+ # @return [String]
764
+ attr_accessor :dataset_region
765
+
766
+ # The BigQuery target dataset id.
767
+ # Corresponds to the JSON property `destinationDatasetId`
768
+ # @return [String]
769
+ attr_accessor :destination_dataset_id
770
+
771
+ # Is this config disabled. When set to true, no runs are scheduled for a given
772
+ # transfer.
773
+ # Corresponds to the JSON property `disabled`
774
+ # @return [Boolean]
775
+ attr_accessor :disabled
776
+ alias_method :disabled?, :disabled
777
+
778
+ # User specified display name for the data transfer.
779
+ # Corresponds to the JSON property `displayName`
780
+ # @return [String]
781
+ attr_accessor :display_name
782
+
783
+ # Represents preferences for sending email notifications for transfer run events.
784
+ # Corresponds to the JSON property `emailPreferences`
785
+ # @return [Google::Apis::BigquerydatatransferV1::EmailPreferences]
786
+ attr_accessor :email_preferences
787
+
788
+ # The resource name of the transfer config. Transfer config names have the form
789
+ # of `projects/`project_id`/locations/`region`/transferConfigs/`config_id``. The
790
+ # name is automatically generated based on the config_id specified in
791
+ # CreateTransferConfigRequest along with project_id and region. If config_id is
792
+ # not provided, usually a uuid, even though it is not guaranteed or required,
793
+ # will be generated for config_id.
794
+ # Corresponds to the JSON property `name`
795
+ # @return [String]
796
+ attr_accessor :name
797
+
798
+ # Output only. Next time when data transfer will run.
799
+ # Corresponds to the JSON property `nextRunTime`
800
+ # @return [String]
801
+ attr_accessor :next_run_time
802
+
803
+ # Pub/Sub topic where notifications will be sent after transfer runs associated
804
+ # with this transfer config finish.
805
+ # Corresponds to the JSON property `notificationPubsubTopic`
806
+ # @return [String]
807
+ attr_accessor :notification_pubsub_topic
808
+
809
+ # Data transfer specific parameters.
810
+ # Corresponds to the JSON property `params`
811
+ # @return [Hash<String,Object>]
812
+ attr_accessor :params
813
+
814
+ # Data transfer schedule. If the data source does not support a custom schedule,
815
+ # this should be empty. If it is empty, the default value for the data source
816
+ # will be used. The specified times are in UTC. Examples of valid format: `1st,
817
+ # 3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first
818
+ # sunday of quarter 00:00`. See more explanation about the format here: https://
819
+ # cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#
820
+ # the_schedule_format NOTE: the granularity should be at least 8 hours, or less
821
+ # frequent.
822
+ # Corresponds to the JSON property `schedule`
823
+ # @return [String]
824
+ attr_accessor :schedule
825
+
826
+ # Options customizing the data transfer schedule.
827
+ # Corresponds to the JSON property `scheduleOptions`
828
+ # @return [Google::Apis::BigquerydatatransferV1::ScheduleOptions]
829
+ attr_accessor :schedule_options
830
+
831
+ # Output only. State of the most recently updated transfer run.
832
+ # Corresponds to the JSON property `state`
833
+ # @return [String]
834
+ attr_accessor :state
835
+
836
+ # Output only. Data transfer modification time. Ignored by server on input.
837
+ # Corresponds to the JSON property `updateTime`
838
+ # @return [String]
839
+ attr_accessor :update_time
840
+
841
+ # Deprecated. Unique ID of the user on whose behalf transfer is done.
842
+ # Corresponds to the JSON property `userId`
843
+ # @return [Fixnum]
844
+ attr_accessor :user_id
845
+
846
+ def initialize(**args)
847
+ update!(**args)
848
+ end
849
+
850
+ # Update properties of this object
851
+ def update!(**args)
852
+ @data_refresh_window_days = args[:data_refresh_window_days] if args.key?(:data_refresh_window_days)
853
+ @data_source_id = args[:data_source_id] if args.key?(:data_source_id)
854
+ @dataset_region = args[:dataset_region] if args.key?(:dataset_region)
855
+ @destination_dataset_id = args[:destination_dataset_id] if args.key?(:destination_dataset_id)
856
+ @disabled = args[:disabled] if args.key?(:disabled)
857
+ @display_name = args[:display_name] if args.key?(:display_name)
858
+ @email_preferences = args[:email_preferences] if args.key?(:email_preferences)
859
+ @name = args[:name] if args.key?(:name)
860
+ @next_run_time = args[:next_run_time] if args.key?(:next_run_time)
861
+ @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
862
+ @params = args[:params] if args.key?(:params)
863
+ @schedule = args[:schedule] if args.key?(:schedule)
864
+ @schedule_options = args[:schedule_options] if args.key?(:schedule_options)
865
+ @state = args[:state] if args.key?(:state)
866
+ @update_time = args[:update_time] if args.key?(:update_time)
867
+ @user_id = args[:user_id] if args.key?(:user_id)
868
+ end
869
+ end
870
+
871
+ # Represents a user facing message for a particular data transfer run.
872
+ class TransferMessage
873
+ include Google::Apis::Core::Hashable
874
+
875
+ # Message text.
876
+ # Corresponds to the JSON property `messageText`
877
+ # @return [String]
878
+ attr_accessor :message_text
879
+
880
+ # Time when message was logged.
881
+ # Corresponds to the JSON property `messageTime`
882
+ # @return [String]
883
+ attr_accessor :message_time
884
+
885
+ # Message severity.
886
+ # Corresponds to the JSON property `severity`
887
+ # @return [String]
888
+ attr_accessor :severity
889
+
890
+ def initialize(**args)
891
+ update!(**args)
892
+ end
893
+
894
+ # Update properties of this object
895
+ def update!(**args)
896
+ @message_text = args[:message_text] if args.key?(:message_text)
897
+ @message_time = args[:message_time] if args.key?(:message_time)
898
+ @severity = args[:severity] if args.key?(:severity)
899
+ end
900
+ end
901
+
902
+ # Represents a data transfer run.
903
+ class TransferRun
904
+ include Google::Apis::Core::Hashable
905
+
906
+ # Output only. Data source id.
907
+ # Corresponds to the JSON property `dataSourceId`
908
+ # @return [String]
909
+ attr_accessor :data_source_id
910
+
911
+ # Output only. The BigQuery target dataset id.
912
+ # Corresponds to the JSON property `destinationDatasetId`
913
+ # @return [String]
914
+ attr_accessor :destination_dataset_id
915
+
916
+ # Represents preferences for sending email notifications for transfer run events.
917
+ # Corresponds to the JSON property `emailPreferences`
918
+ # @return [Google::Apis::BigquerydatatransferV1::EmailPreferences]
919
+ attr_accessor :email_preferences
920
+
921
+ # Output only. Time when transfer run ended. Parameter ignored by server for
922
+ # input requests.
923
+ # Corresponds to the JSON property `endTime`
924
+ # @return [String]
925
+ attr_accessor :end_time
926
+
927
+ # The `Status` type defines a logical error model that is suitable for different
928
+ # programming environments, including REST APIs and RPC APIs. It is used by [
929
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
930
+ # data: error code, error message, and error details. You can find out more
931
+ # about this error model and how to work with it in the [API Design Guide](https:
932
+ # //cloud.google.com/apis/design/errors).
933
+ # Corresponds to the JSON property `errorStatus`
934
+ # @return [Google::Apis::BigquerydatatransferV1::Status]
935
+ attr_accessor :error_status
936
+
937
+ # The resource name of the transfer run. Transfer run names have the form `
938
+ # projects/`project_id`/locations/`location`/transferConfigs/`config_id`/runs/`
939
+ # run_id``. The name is ignored when creating a transfer run.
940
+ # Corresponds to the JSON property `name`
941
+ # @return [String]
942
+ attr_accessor :name
943
+
944
+ # Output only. Pub/Sub topic where a notification will be sent after this
945
+ # transfer run finishes
946
+ # Corresponds to the JSON property `notificationPubsubTopic`
947
+ # @return [String]
948
+ attr_accessor :notification_pubsub_topic
949
+
950
+ # Output only. Data transfer specific parameters.
951
+ # Corresponds to the JSON property `params`
952
+ # @return [Hash<String,Object>]
953
+ attr_accessor :params
954
+
955
+ # For batch transfer runs, specifies the date and time of the data should be
956
+ # ingested.
957
+ # Corresponds to the JSON property `runTime`
958
+ # @return [String]
959
+ attr_accessor :run_time
960
+
961
+ # Output only. Describes the schedule of this transfer run if it was created as
962
+ # part of a regular schedule. For batch transfer runs that are scheduled
963
+ # manually, this is empty. NOTE: the system might choose to delay the schedule
964
+ # depending on the current load, so `schedule_time` doesn't always match this.
965
+ # Corresponds to the JSON property `schedule`
966
+ # @return [String]
967
+ attr_accessor :schedule
968
+
969
+ # Minimum time after which a transfer run can be started.
970
+ # Corresponds to the JSON property `scheduleTime`
971
+ # @return [String]
972
+ attr_accessor :schedule_time
973
+
974
+ # Output only. Time when transfer run was started. Parameter ignored by server
975
+ # for input requests.
976
+ # Corresponds to the JSON property `startTime`
977
+ # @return [String]
978
+ attr_accessor :start_time
979
+
980
+ # Data transfer run state. Ignored for input requests.
981
+ # Corresponds to the JSON property `state`
982
+ # @return [String]
983
+ attr_accessor :state
984
+
985
+ # Output only. Last time the data transfer run state was updated.
986
+ # Corresponds to the JSON property `updateTime`
987
+ # @return [String]
988
+ attr_accessor :update_time
989
+
990
+ # Deprecated. Unique ID of the user on whose behalf transfer is done.
991
+ # Corresponds to the JSON property `userId`
992
+ # @return [Fixnum]
993
+ attr_accessor :user_id
994
+
995
+ def initialize(**args)
996
+ update!(**args)
997
+ end
998
+
999
+ # Update properties of this object
1000
+ def update!(**args)
1001
+ @data_source_id = args[:data_source_id] if args.key?(:data_source_id)
1002
+ @destination_dataset_id = args[:destination_dataset_id] if args.key?(:destination_dataset_id)
1003
+ @email_preferences = args[:email_preferences] if args.key?(:email_preferences)
1004
+ @end_time = args[:end_time] if args.key?(:end_time)
1005
+ @error_status = args[:error_status] if args.key?(:error_status)
1006
+ @name = args[:name] if args.key?(:name)
1007
+ @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
1008
+ @params = args[:params] if args.key?(:params)
1009
+ @run_time = args[:run_time] if args.key?(:run_time)
1010
+ @schedule = args[:schedule] if args.key?(:schedule)
1011
+ @schedule_time = args[:schedule_time] if args.key?(:schedule_time)
1012
+ @start_time = args[:start_time] if args.key?(:start_time)
1013
+ @state = args[:state] if args.key?(:state)
1014
+ @update_time = args[:update_time] if args.key?(:update_time)
1015
+ @user_id = args[:user_id] if args.key?(:user_id)
1016
+ end
1017
+ end
1018
+ end
1019
+ end
1020
+ end