google-cloud-bigquery-data_transfer 0.7.0 → 1.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +3 -2
- data/AUTHENTICATION.md +51 -59
- data/LICENSE.md +203 -0
- data/MIGRATING.md +301 -0
- data/README.md +33 -45
- data/lib/{google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datasource.rb → google-cloud-bigquery-data_transfer.rb} +5 -11
- data/lib/google/cloud/bigquery/data_transfer.rb +88 -140
- data/lib/google/cloud/bigquery/data_transfer/version.rb +6 -2
- metadata +60 -68
- data/LICENSE +0 -201
- data/lib/google/cloud/bigquery/data_transfer/credentials.rb +0 -33
- data/lib/google/cloud/bigquery/data_transfer/v1.rb +0 -173
- data/lib/google/cloud/bigquery/data_transfer/v1/credentials.rb +0 -43
- data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_pb.rb +0 -190
- data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb +0 -1177
- data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client_config.json +0 -96
- data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_services_pb.rb +0 -87
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/data_transfer/v1/data_transfer.rb +0 -500
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/data_transfer/v1/transfer.rb +0 -217
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb +0 -565
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb +0 -257
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/protobuf/any.rb +0 -131
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/protobuf/duration.rb +0 -91
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/protobuf/empty.rb +0 -29
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/protobuf/field_mask.rb +0 -222
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/protobuf/struct.rb +0 -74
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/protobuf/timestamp.rb +0 -113
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/protobuf/wrappers.rb +0 -26
- data/lib/google/cloud/bigquery/data_transfer/v1/doc/google/rpc/status.rb +0 -39
- data/lib/google/cloud/bigquery/data_transfer/v1/transfer_pb.rb +0 -83
- data/lib/google/cloud/bigquery/datatransfer/v1/datasource_pb.rb +0 -170
- data/lib/google/cloud/bigquery/datatransfer/v1/datasource_services_pb.rb +0 -103
- data/lib/google/cloud/bigquery/datatransfer/v1/datatransfer_pb.rb +0 -215
- data/lib/google/cloud/bigquery/datatransfer/v1/datatransfer_services_pb.rb +0 -94
- data/lib/google/cloud/bigquery/datatransfer/v1/transfer_pb.rb +0 -103
@@ -1,217 +0,0 @@
|
|
1
|
-
# Copyright 2018 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
|
-
# https://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
|
-
|
16
|
-
module Google
|
17
|
-
module Cloud
|
18
|
-
module Bigquery
|
19
|
-
module DataTransfer
|
20
|
-
module V1
|
21
|
-
# Represents a data transfer configuration. A transfer configuration
|
22
|
-
# contains all metadata needed to perform a data transfer. For example,
|
23
|
-
# +destination_dataset_id+ specifies where data should be stored.
|
24
|
-
# When a new transfer configuration is created, the specified
|
25
|
-
# +destination_dataset_id+ is created when needed and shared with the
|
26
|
-
# appropriate data source service account.
|
27
|
-
# Next id: 20
|
28
|
-
# @!attribute [rw] name
|
29
|
-
# @return [String]
|
30
|
-
# The resource name of the transfer config.
|
31
|
-
# Transfer config names have the form
|
32
|
-
# +projects/\\{project_id}/transferConfigs/\\{config_id}+.
|
33
|
-
# Where +config_id+ is usually a uuid, even though it is not
|
34
|
-
# guaranteed or required. The name is ignored when creating a transfer
|
35
|
-
# config.
|
36
|
-
# @!attribute [rw] destination_dataset_id
|
37
|
-
# @return [String]
|
38
|
-
# The BigQuery target dataset id.
|
39
|
-
# @!attribute [rw] display_name
|
40
|
-
# @return [String]
|
41
|
-
# User specified display name for the data transfer.
|
42
|
-
# @!attribute [rw] data_source_id
|
43
|
-
# @return [String]
|
44
|
-
# Data source id. Cannot be changed once data transfer is created.
|
45
|
-
# @!attribute [rw] params
|
46
|
-
# @return [Google::Protobuf::Struct]
|
47
|
-
# Data transfer specific parameters.
|
48
|
-
# @!attribute [rw] schedule
|
49
|
-
# @return [String]
|
50
|
-
# Data transfer schedule.
|
51
|
-
# If the data source does not support a custom schedule, this should be
|
52
|
-
# empty. If it is empty, the default value for the data source will be
|
53
|
-
# used.
|
54
|
-
# The specified times are in UTC.
|
55
|
-
# Examples of valid format:
|
56
|
-
# +1st,3rd monday of month 15:30+,
|
57
|
-
# +every wed,fri of jan,jun 13:15+, and
|
58
|
-
# +first sunday of quarter 00:00+.
|
59
|
-
# See more explanation about the format here:
|
60
|
-
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
|
61
|
-
# NOTE: the granularity should be at least 8 hours, or less frequent.
|
62
|
-
# @!attribute [rw] data_refresh_window_days
|
63
|
-
# @return [Integer]
|
64
|
-
# The number of days to look back to automatically refresh the data.
|
65
|
-
# For example, if +data_refresh_window_days = 10+, then every day
|
66
|
-
# BigQuery reingests data for [today-10, today-1], rather than ingesting data
|
67
|
-
# for just [today-1].
|
68
|
-
# Only valid if the data source supports the feature. Set the value to 0
|
69
|
-
# to use the default value.
|
70
|
-
# @!attribute [rw] disabled
|
71
|
-
# @return [true, false]
|
72
|
-
# Is this config disabled. When set to true, no runs are scheduled
|
73
|
-
# for a given transfer.
|
74
|
-
# @!attribute [rw] update_time
|
75
|
-
# @return [Google::Protobuf::Timestamp]
|
76
|
-
# Output only. Data transfer modification time. Ignored by server on input.
|
77
|
-
# @!attribute [rw] next_run_time
|
78
|
-
# @return [Google::Protobuf::Timestamp]
|
79
|
-
# Output only. Next time when data transfer will run.
|
80
|
-
# @!attribute [rw] state
|
81
|
-
# @return [Google::Cloud::Bigquery::DataTransfer::V1::TransferState]
|
82
|
-
# Output only. State of the most recently updated transfer run.
|
83
|
-
# @!attribute [rw] user_id
|
84
|
-
# @return [Integer]
|
85
|
-
# Output only. Unique ID of the user on whose behalf transfer is done.
|
86
|
-
# Applicable only to data sources that do not support service accounts.
|
87
|
-
# When set to 0, the data source service account credentials are used.
|
88
|
-
# May be negative. Note, that this identifier is not stable.
|
89
|
-
# It may change over time even for the same user.
|
90
|
-
# @!attribute [rw] dataset_region
|
91
|
-
# @return [String]
|
92
|
-
# Output only. Region in which BigQuery dataset is located.
|
93
|
-
class TransferConfig; end
|
94
|
-
|
95
|
-
# Represents a data transfer run.
|
96
|
-
# Next id: 27
|
97
|
-
# @!attribute [rw] name
|
98
|
-
# @return [String]
|
99
|
-
# The resource name of the transfer run.
|
100
|
-
# Transfer run names have the form
|
101
|
-
# +projects/\\{project_id}/locations/\\{location}/transferConfigs/\\{config_id}/runs/\\{run_id}+.
|
102
|
-
# The name is ignored when creating a transfer run.
|
103
|
-
# @!attribute [rw] schedule_time
|
104
|
-
# @return [Google::Protobuf::Timestamp]
|
105
|
-
# Minimum time after which a transfer run can be started.
|
106
|
-
# @!attribute [rw] run_time
|
107
|
-
# @return [Google::Protobuf::Timestamp]
|
108
|
-
# For batch transfer runs, specifies the date and time that
|
109
|
-
# data should be ingested.
|
110
|
-
# @!attribute [rw] error_status
|
111
|
-
# @return [Google::Rpc::Status]
|
112
|
-
# Status of the transfer run.
|
113
|
-
# @!attribute [rw] start_time
|
114
|
-
# @return [Google::Protobuf::Timestamp]
|
115
|
-
# Output only. Time when transfer run was started.
|
116
|
-
# Parameter ignored by server for input requests.
|
117
|
-
# @!attribute [rw] end_time
|
118
|
-
# @return [Google::Protobuf::Timestamp]
|
119
|
-
# Output only. Time when transfer run ended.
|
120
|
-
# Parameter ignored by server for input requests.
|
121
|
-
# @!attribute [rw] update_time
|
122
|
-
# @return [Google::Protobuf::Timestamp]
|
123
|
-
# Output only. Last time the data transfer run state was updated.
|
124
|
-
# @!attribute [rw] params
|
125
|
-
# @return [Google::Protobuf::Struct]
|
126
|
-
# Output only. Data transfer specific parameters.
|
127
|
-
# @!attribute [rw] destination_dataset_id
|
128
|
-
# @return [String]
|
129
|
-
# Output only. The BigQuery target dataset id.
|
130
|
-
# @!attribute [rw] data_source_id
|
131
|
-
# @return [String]
|
132
|
-
# Output only. Data source id.
|
133
|
-
# @!attribute [rw] state
|
134
|
-
# @return [Google::Cloud::Bigquery::DataTransfer::V1::TransferState]
|
135
|
-
# Data transfer run state. Ignored for input requests.
|
136
|
-
# @!attribute [rw] user_id
|
137
|
-
# @return [Integer]
|
138
|
-
# Output only. Unique ID of the user on whose behalf transfer is done.
|
139
|
-
# Applicable only to data sources that do not support service accounts.
|
140
|
-
# When set to 0, the data source service account credentials are used.
|
141
|
-
# May be negative. Note, that this identifier is not stable.
|
142
|
-
# It may change over time even for the same user.
|
143
|
-
# @!attribute [rw] schedule
|
144
|
-
# @return [String]
|
145
|
-
# Output only. Describes the schedule of this transfer run if it was
|
146
|
-
# created as part of a regular schedule. For batch transfer runs that are
|
147
|
-
# scheduled manually, this is empty.
|
148
|
-
# NOTE: the system might choose to delay the schedule depending on the
|
149
|
-
# current load, so +schedule_time+ doesn't always matches this.
|
150
|
-
class TransferRun; end
|
151
|
-
|
152
|
-
# Represents a user facing message for a particular data transfer run.
|
153
|
-
# @!attribute [rw] message_time
|
154
|
-
# @return [Google::Protobuf::Timestamp]
|
155
|
-
# Time when message was logged.
|
156
|
-
# @!attribute [rw] severity
|
157
|
-
# @return [Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage::MessageSeverity]
|
158
|
-
# Message severity.
|
159
|
-
# @!attribute [rw] message_text
|
160
|
-
# @return [String]
|
161
|
-
# Message text.
|
162
|
-
class TransferMessage
|
163
|
-
# Represents data transfer user facing message severity.
|
164
|
-
module MessageSeverity
|
165
|
-
# No severity specified.
|
166
|
-
MESSAGE_SEVERITY_UNSPECIFIED = 0
|
167
|
-
|
168
|
-
# Informational message.
|
169
|
-
INFO = 1
|
170
|
-
|
171
|
-
# Warning message.
|
172
|
-
WARNING = 2
|
173
|
-
|
174
|
-
# Error message.
|
175
|
-
ERROR = 3
|
176
|
-
end
|
177
|
-
end
|
178
|
-
|
179
|
-
# Represents data transfer type.
|
180
|
-
module TransferType
|
181
|
-
# Invalid or Unknown transfer type placeholder.
|
182
|
-
TRANSFER_TYPE_UNSPECIFIED = 0
|
183
|
-
|
184
|
-
# Batch data transfer.
|
185
|
-
BATCH = 1
|
186
|
-
|
187
|
-
# Streaming data transfer. Streaming data source currently doesn't
|
188
|
-
# support multiple transfer configs per project.
|
189
|
-
STREAMING = 2
|
190
|
-
end
|
191
|
-
|
192
|
-
# Represents data transfer run state.
|
193
|
-
module TransferState
|
194
|
-
# State placeholder.
|
195
|
-
TRANSFER_STATE_UNSPECIFIED = 0
|
196
|
-
|
197
|
-
# Data transfer is scheduled and is waiting to be picked up by
|
198
|
-
# data transfer backend.
|
199
|
-
PENDING = 2
|
200
|
-
|
201
|
-
# Data transfer is in progress.
|
202
|
-
RUNNING = 3
|
203
|
-
|
204
|
-
# Data transfer completed successsfully.
|
205
|
-
SUCCEEDED = 4
|
206
|
-
|
207
|
-
# Data transfer failed.
|
208
|
-
FAILED = 5
|
209
|
-
|
210
|
-
# Data transfer is cancelled.
|
211
|
-
CANCELLED = 6
|
212
|
-
end
|
213
|
-
end
|
214
|
-
end
|
215
|
-
end
|
216
|
-
end
|
217
|
-
end
|
@@ -1,565 +0,0 @@
|
|
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
|
-
# https://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
|
-
|
16
|
-
module Google
|
17
|
-
module Cloud
|
18
|
-
module Bigquery
|
19
|
-
module Datatransfer
|
20
|
-
module V1
|
21
|
-
# Represents a data source parameter with validation rules, so that
|
22
|
-
# parameters can be rendered in the UI. These parameters are given to us by
|
23
|
-
# supported data sources, and include all needed information for rendering
|
24
|
-
# and validation.
|
25
|
-
# Thus, whoever uses this api can decide to generate either generic ui,
|
26
|
-
# or custom data source specific forms.
|
27
|
-
# @!attribute [rw] param_id
|
28
|
-
# @return [String]
|
29
|
-
# Parameter identifier.
|
30
|
-
# @!attribute [rw] display_name
|
31
|
-
# @return [String]
|
32
|
-
# Parameter display name in the user interface.
|
33
|
-
# @!attribute [rw] description
|
34
|
-
# @return [String]
|
35
|
-
# Parameter description.
|
36
|
-
# @!attribute [rw] type
|
37
|
-
# @return [Google::Cloud::Bigquery::Datatransfer::V1::DataSourceParameter::Type]
|
38
|
-
# Parameter type.
|
39
|
-
# @!attribute [rw] required
|
40
|
-
# @return [true, false]
|
41
|
-
# Is parameter required.
|
42
|
-
# @!attribute [rw] repeated
|
43
|
-
# @return [true, false]
|
44
|
-
# Deprecated. This field has no effect.
|
45
|
-
# @!attribute [rw] validation_regex
|
46
|
-
# @return [String]
|
47
|
-
# Regular expression which can be used for parameter validation.
|
48
|
-
# @!attribute [rw] allowed_values
|
49
|
-
# @return [Array<String>]
|
50
|
-
# All possible values for the parameter.
|
51
|
-
# @!attribute [rw] min_value
|
52
|
-
# @return [Google::Protobuf::DoubleValue]
|
53
|
-
# For integer and double values specifies minimum allowed value.
|
54
|
-
# @!attribute [rw] max_value
|
55
|
-
# @return [Google::Protobuf::DoubleValue]
|
56
|
-
# For integer and double values specifies maxminum allowed value.
|
57
|
-
# @!attribute [rw] fields
|
58
|
-
# @return [Array<Google::Cloud::Bigquery::Datatransfer::V1::DataSourceParameter>]
|
59
|
-
# Deprecated. This field has no effect.
|
60
|
-
# @!attribute [rw] validation_description
|
61
|
-
# @return [String]
|
62
|
-
# Description of the requirements for this field, in case the user input does
|
63
|
-
# not fulfill the regex pattern or min/max values.
|
64
|
-
# @!attribute [rw] validation_help_url
|
65
|
-
# @return [String]
|
66
|
-
# URL to a help document to further explain the naming requirements.
|
67
|
-
# @!attribute [rw] immutable
|
68
|
-
# @return [true, false]
|
69
|
-
# Cannot be changed after initial creation.
|
70
|
-
# @!attribute [rw] recurse
|
71
|
-
# @return [true, false]
|
72
|
-
# Deprecated. This field has no effect.
|
73
|
-
# @!attribute [rw] deprecated
|
74
|
-
# @return [true, false]
|
75
|
-
# If true, it should not be used in new transfers, and it should not be
|
76
|
-
# visible to users.
|
77
|
-
class DataSourceParameter
|
78
|
-
# Parameter type.
|
79
|
-
module Type
|
80
|
-
# Type unspecified.
|
81
|
-
TYPE_UNSPECIFIED = 0
|
82
|
-
|
83
|
-
# String parameter.
|
84
|
-
STRING = 1
|
85
|
-
|
86
|
-
# Integer parameter (64-bits).
|
87
|
-
# Will be serialized to json as string.
|
88
|
-
INTEGER = 2
|
89
|
-
|
90
|
-
# Double precision floating point parameter.
|
91
|
-
DOUBLE = 3
|
92
|
-
|
93
|
-
# Boolean parameter.
|
94
|
-
BOOLEAN = 4
|
95
|
-
|
96
|
-
# Deprecated. This field has no effect.
|
97
|
-
RECORD = 5
|
98
|
-
|
99
|
-
# Page ID for a Google+ Page.
|
100
|
-
PLUS_PAGE = 6
|
101
|
-
end
|
102
|
-
end
|
103
|
-
|
104
|
-
# Represents data source metadata. Metadata is sufficient to
|
105
|
-
# render UI and request proper OAuth tokens.
|
106
|
-
# @!attribute [rw] name
|
107
|
-
# @return [String]
|
108
|
-
# Output only. Data source resource name.
|
109
|
-
# @!attribute [rw] data_source_id
|
110
|
-
# @return [String]
|
111
|
-
# Data source id.
|
112
|
-
# @!attribute [rw] display_name
|
113
|
-
# @return [String]
|
114
|
-
# User friendly data source name.
|
115
|
-
# @!attribute [rw] description
|
116
|
-
# @return [String]
|
117
|
-
# User friendly data source description string.
|
118
|
-
# @!attribute [rw] client_id
|
119
|
-
# @return [String]
|
120
|
-
# Data source client id which should be used to receive refresh token.
|
121
|
-
# @!attribute [rw] scopes
|
122
|
-
# @return [Array<String>]
|
123
|
-
# Api auth scopes for which refresh token needs to be obtained. These are
|
124
|
-
# scopes needed by a data source to prepare data and ingest them into
|
125
|
-
# BigQuery, e.g., https://www.googleapis.com/auth/bigquery
|
126
|
-
# @!attribute [rw] transfer_type
|
127
|
-
# @return [Google::Cloud::Bigquery::Datatransfer::V1::TransferType]
|
128
|
-
# Deprecated. This field has no effect.
|
129
|
-
# @!attribute [rw] supports_multiple_transfers
|
130
|
-
# @return [true, false]
|
131
|
-
# Deprecated. This field has no effect.
|
132
|
-
# @!attribute [rw] update_deadline_seconds
|
133
|
-
# @return [Integer]
|
134
|
-
# The number of seconds to wait for an update from the data source
|
135
|
-
# before the Data Transfer Service marks the transfer as FAILED.
|
136
|
-
# @!attribute [rw] default_schedule
|
137
|
-
# @return [String]
|
138
|
-
# Default data transfer schedule.
|
139
|
-
# Examples of valid schedules include:
|
140
|
-
# `1st,3rd monday of month 15:30`,
|
141
|
-
# `every wed,fri of jan,jun 13:15`, and
|
142
|
-
# `first sunday of quarter 00:00`.
|
143
|
-
# @!attribute [rw] supports_custom_schedule
|
144
|
-
# @return [true, false]
|
145
|
-
# Specifies whether the data source supports a user defined schedule, or
|
146
|
-
# operates on the default schedule.
|
147
|
-
# When set to `true`, user can override default schedule.
|
148
|
-
# @!attribute [rw] parameters
|
149
|
-
# @return [Array<Google::Cloud::Bigquery::Datatransfer::V1::DataSourceParameter>]
|
150
|
-
# Data source parameters.
|
151
|
-
# @!attribute [rw] help_url
|
152
|
-
# @return [String]
|
153
|
-
# Url for the help document for this data source.
|
154
|
-
# @!attribute [rw] authorization_type
|
155
|
-
# @return [Google::Cloud::Bigquery::Datatransfer::V1::DataSource::AuthorizationType]
|
156
|
-
# Indicates the type of authorization.
|
157
|
-
# @!attribute [rw] data_refresh_type
|
158
|
-
# @return [Google::Cloud::Bigquery::Datatransfer::V1::DataSource::DataRefreshType]
|
159
|
-
# Specifies whether the data source supports automatic data refresh for the
|
160
|
-
# past few days, and how it's supported.
|
161
|
-
# For some data sources, data might not be complete until a few days later,
|
162
|
-
# so it's useful to refresh data automatically.
|
163
|
-
# @!attribute [rw] default_data_refresh_window_days
|
164
|
-
# @return [Integer]
|
165
|
-
# Default data refresh window on days.
|
166
|
-
# Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
|
167
|
-
# @!attribute [rw] manual_runs_disabled
|
168
|
-
# @return [true, false]
|
169
|
-
# Disables backfilling and manual run scheduling
|
170
|
-
# for the data source.
|
171
|
-
# @!attribute [rw] minimum_schedule_interval
|
172
|
-
# @return [Google::Protobuf::Duration]
|
173
|
-
# The minimum interval for scheduler to schedule runs.
|
174
|
-
class DataSource
|
175
|
-
# The type of authorization needed for this data source.
|
176
|
-
module AuthorizationType
|
177
|
-
# Type unspecified.
|
178
|
-
AUTHORIZATION_TYPE_UNSPECIFIED = 0
|
179
|
-
|
180
|
-
# Use OAuth 2 authorization codes that can be exchanged
|
181
|
-
# for a refresh token on the backend.
|
182
|
-
AUTHORIZATION_CODE = 1
|
183
|
-
|
184
|
-
# Return an authorization code for a given Google+ page that can then be
|
185
|
-
# exchanged for a refresh token on the backend.
|
186
|
-
GOOGLE_PLUS_AUTHORIZATION_CODE = 2
|
187
|
-
end
|
188
|
-
|
189
|
-
# Represents how the data source supports data auto refresh.
|
190
|
-
module DataRefreshType
|
191
|
-
# The data source won't support data auto refresh, which is default value.
|
192
|
-
DATA_REFRESH_TYPE_UNSPECIFIED = 0
|
193
|
-
|
194
|
-
# The data source supports data auto refresh, and runs will be scheduled
|
195
|
-
# for the past few days. Does not allow custom values to be set for each
|
196
|
-
# transfer config.
|
197
|
-
SLIDING_WINDOW = 1
|
198
|
-
|
199
|
-
# The data source supports data auto refresh, and runs will be scheduled
|
200
|
-
# for the past few days. Allows custom values to be set for each transfer
|
201
|
-
# config.
|
202
|
-
CUSTOM_SLIDING_WINDOW = 2
|
203
|
-
end
|
204
|
-
end
|
205
|
-
|
206
|
-
# A request to get data source info.
|
207
|
-
# @!attribute [rw] name
|
208
|
-
# @return [String]
|
209
|
-
# Required. The field will contain name of the resource requested, for example:
|
210
|
-
# `projects/{project_id}/dataSources/{data_source_id}` or
|
211
|
-
# `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
|
212
|
-
class GetDataSourceRequest; end
|
213
|
-
|
214
|
-
# Request to list supported data sources and their data transfer settings.
|
215
|
-
# @!attribute [rw] parent
|
216
|
-
# @return [String]
|
217
|
-
# Required. The BigQuery project id for which data sources should be returned.
|
218
|
-
# Must be in the form: `projects/{project_id}` or
|
219
|
-
# `projects/{project_id}/locations/{location_id}
|
220
|
-
# @!attribute [rw] page_token
|
221
|
-
# @return [String]
|
222
|
-
# Pagination token, which can be used to request a specific page
|
223
|
-
# of `ListDataSourcesRequest` list results. For multiple-page
|
224
|
-
# results, `ListDataSourcesResponse` outputs
|
225
|
-
# a `next_page` token, which can be used as the
|
226
|
-
# `page_token` value to request the next page of list results.
|
227
|
-
# @!attribute [rw] page_size
|
228
|
-
# @return [Integer]
|
229
|
-
# Page size. The default page size is the maximum value of 1000 results.
|
230
|
-
class ListDataSourcesRequest; end
|
231
|
-
|
232
|
-
# Returns list of supported data sources and their metadata.
|
233
|
-
# @!attribute [rw] data_sources
|
234
|
-
# @return [Array<Google::Cloud::Bigquery::Datatransfer::V1::DataSource>]
|
235
|
-
# List of supported data sources and their transfer settings.
|
236
|
-
# @!attribute [rw] next_page_token
|
237
|
-
# @return [String]
|
238
|
-
# Output only. The next-pagination token. For multiple-page list results,
|
239
|
-
# this token can be used as the
|
240
|
-
# `ListDataSourcesRequest.page_token`
|
241
|
-
# to request the next page of list results.
|
242
|
-
class ListDataSourcesResponse; end
|
243
|
-
|
244
|
-
# A request to create a data transfer configuration. If new credentials are
|
245
|
-
# needed for this transfer configuration, an authorization code must be
|
246
|
-
# provided. If an authorization code is provided, the transfer configuration
|
247
|
-
# will be associated with the user id corresponding to the
|
248
|
-
# authorization code. Otherwise, the transfer configuration will be associated
|
249
|
-
# with the calling user.
|
250
|
-
# @!attribute [rw] parent
|
251
|
-
# @return [String]
|
252
|
-
# Required. The BigQuery project id where the transfer configuration should be created.
|
253
|
-
# Must be in the format projects/\\{project_id}/locations/\\{location_id} or
|
254
|
-
# projects/\\{project_id}. If specified location and location of the
|
255
|
-
# destination bigquery dataset do not match - the request will fail.
|
256
|
-
# @!attribute [rw] transfer_config
|
257
|
-
# @return [Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig]
|
258
|
-
# Required. Data transfer configuration to create.
|
259
|
-
# @!attribute [rw] authorization_code
|
260
|
-
# @return [String]
|
261
|
-
# Optional OAuth2 authorization code to use with this transfer configuration.
|
262
|
-
# This is required if new credentials are needed, as indicated by
|
263
|
-
# `CheckValidCreds`.
|
264
|
-
# In order to obtain authorization_code, please make a
|
265
|
-
# request to
|
266
|
-
# https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
|
267
|
-
#
|
268
|
-
# * client_id should be OAuth client_id of BigQuery DTS API for the given
|
269
|
-
# data source returned by ListDataSources method.
|
270
|
-
# * data_source_scopes are the scopes returned by ListDataSources method.
|
271
|
-
# * redirect_uri is an optional parameter. If not specified, then
|
272
|
-
# authorization code is posted to the opener of authorization flow window.
|
273
|
-
# Otherwise it will be sent to the redirect uri. A special value of
|
274
|
-
# urn:ietf:wg:oauth:2.0:oob means that authorization code should be
|
275
|
-
# returned in the title bar of the browser, with the page text prompting
|
276
|
-
# the user to copy the code and paste it in the application.
|
277
|
-
# @!attribute [rw] version_info
|
278
|
-
# @return [String]
|
279
|
-
# Optional version info. If users want to find a very recent access token,
|
280
|
-
# that is, immediately after approving access, users have to set the
|
281
|
-
# version_info claim in the token request. To obtain the version_info, users
|
282
|
-
# must use the "none+gsession" response type. which be return a
|
283
|
-
# version_info back in the authorization response which be be put in a JWT
|
284
|
-
# claim in the token request.
|
285
|
-
# @!attribute [rw] service_account_name
|
286
|
-
# @return [String]
|
287
|
-
# Optional service account name. If this field is set, transfer config will
|
288
|
-
# be created with this service account credentials. It requires that
|
289
|
-
# requesting user calling this API has permissions to act as this service
|
290
|
-
# account.
|
291
|
-
class CreateTransferConfigRequest; end
|
292
|
-
|
293
|
-
# A request to update a transfer configuration. To update the user id of the
|
294
|
-
# transfer configuration, an authorization code needs to be provided.
|
295
|
-
# @!attribute [rw] transfer_config
|
296
|
-
# @return [Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig]
|
297
|
-
# Required. Data transfer configuration to create.
|
298
|
-
# @!attribute [rw] authorization_code
|
299
|
-
# @return [String]
|
300
|
-
# Optional OAuth2 authorization code to use with this transfer configuration.
|
301
|
-
# If it is provided, the transfer configuration will be associated with the
|
302
|
-
# authorizing user.
|
303
|
-
# In order to obtain authorization_code, please make a
|
304
|
-
# request to
|
305
|
-
# https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
|
306
|
-
#
|
307
|
-
# * client_id should be OAuth client_id of BigQuery DTS API for the given
|
308
|
-
# data source returned by ListDataSources method.
|
309
|
-
# * data_source_scopes are the scopes returned by ListDataSources method.
|
310
|
-
# * redirect_uri is an optional parameter. If not specified, then
|
311
|
-
# authorization code is posted to the opener of authorization flow window.
|
312
|
-
# Otherwise it will be sent to the redirect uri. A special value of
|
313
|
-
# urn:ietf:wg:oauth:2.0:oob means that authorization code should be
|
314
|
-
# returned in the title bar of the browser, with the page text prompting
|
315
|
-
# the user to copy the code and paste it in the application.
|
316
|
-
# @!attribute [rw] update_mask
|
317
|
-
# @return [Google::Protobuf::FieldMask]
|
318
|
-
# Required. Required list of fields to be updated in this request.
|
319
|
-
# @!attribute [rw] version_info
|
320
|
-
# @return [String]
|
321
|
-
# Optional version info. If users want to find a very recent access token,
|
322
|
-
# that is, immediately after approving access, users have to set the
|
323
|
-
# version_info claim in the token request. To obtain the version_info, users
|
324
|
-
# must use the "none+gsession" response type. which be return a
|
325
|
-
# version_info back in the authorization response which be be put in a JWT
|
326
|
-
# claim in the token request.
|
327
|
-
# @!attribute [rw] service_account_name
|
328
|
-
# @return [String]
|
329
|
-
# Optional service account name. If this field is set and
|
330
|
-
# "service_account_name" is set in update_mask, transfer config will be
|
331
|
-
# updated to use this service account credentials. It requires that
|
332
|
-
# requesting user calling this API has permissions to act as this service
|
333
|
-
# account.
|
334
|
-
class UpdateTransferConfigRequest; end
|
335
|
-
|
336
|
-
# A request to get data transfer information.
|
337
|
-
# @!attribute [rw] name
|
338
|
-
# @return [String]
|
339
|
-
# Required. The field will contain name of the resource requested, for example:
|
340
|
-
# `projects/{project_id}/transferConfigs/{config_id}` or
|
341
|
-
# `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
|
342
|
-
class GetTransferConfigRequest; end
|
343
|
-
|
344
|
-
# A request to delete data transfer information. All associated transfer runs
|
345
|
-
# and log messages will be deleted as well.
|
346
|
-
# @!attribute [rw] name
|
347
|
-
# @return [String]
|
348
|
-
# Required. The field will contain name of the resource requested, for example:
|
349
|
-
# `projects/{project_id}/transferConfigs/{config_id}` or
|
350
|
-
# `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
|
351
|
-
class DeleteTransferConfigRequest; end
|
352
|
-
|
353
|
-
# A request to get data transfer run information.
|
354
|
-
# @!attribute [rw] name
|
355
|
-
# @return [String]
|
356
|
-
# Required. The field will contain name of the resource requested, for example:
|
357
|
-
# `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
|
358
|
-
# `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
|
359
|
-
class GetTransferRunRequest; end
|
360
|
-
|
361
|
-
# A request to delete data transfer run information.
|
362
|
-
# @!attribute [rw] name
|
363
|
-
# @return [String]
|
364
|
-
# Required. The field will contain name of the resource requested, for example:
|
365
|
-
# `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
|
366
|
-
# `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
|
367
|
-
class DeleteTransferRunRequest; end
|
368
|
-
|
369
|
-
# A request to list data transfers configured for a BigQuery project.
|
370
|
-
# @!attribute [rw] parent
|
371
|
-
# @return [String]
|
372
|
-
# Required. The BigQuery project id for which data sources
|
373
|
-
# should be returned: `projects/{project_id}` or
|
374
|
-
# `projects/{project_id}/locations/{location_id}`
|
375
|
-
# @!attribute [rw] data_source_ids
|
376
|
-
# @return [Array<String>]
|
377
|
-
# When specified, only configurations of requested data sources are returned.
|
378
|
-
# @!attribute [rw] page_token
|
379
|
-
# @return [String]
|
380
|
-
# Pagination token, which can be used to request a specific page
|
381
|
-
# of `ListTransfersRequest` list results. For multiple-page
|
382
|
-
# results, `ListTransfersResponse` outputs
|
383
|
-
# a `next_page` token, which can be used as the
|
384
|
-
# `page_token` value to request the next page of list results.
|
385
|
-
# @!attribute [rw] page_size
|
386
|
-
# @return [Integer]
|
387
|
-
# Page size. The default page size is the maximum value of 1000 results.
|
388
|
-
class ListTransferConfigsRequest; end
|
389
|
-
|
390
|
-
# The returned list of pipelines in the project.
|
391
|
-
# @!attribute [rw] transfer_configs
|
392
|
-
# @return [Array<Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig>]
|
393
|
-
# Output only. The stored pipeline transfer configurations.
|
394
|
-
# @!attribute [rw] next_page_token
|
395
|
-
# @return [String]
|
396
|
-
# Output only. The next-pagination token. For multiple-page list results,
|
397
|
-
# this token can be used as the
|
398
|
-
# `ListTransferConfigsRequest.page_token`
|
399
|
-
# to request the next page of list results.
|
400
|
-
class ListTransferConfigsResponse; end
|
401
|
-
|
402
|
-
# A request to list data transfer runs. UI can use this method to show/filter
|
403
|
-
# specific data transfer runs. The data source can use this method to request
|
404
|
-
# all scheduled transfer runs.
|
405
|
-
# @!attribute [rw] parent
|
406
|
-
# @return [String]
|
407
|
-
# Required. Name of transfer configuration for which transfer runs should be retrieved.
|
408
|
-
# Format of transfer configuration resource name is:
|
409
|
-
# `projects/{project_id}/transferConfigs/{config_id}` or
|
410
|
-
# `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
|
411
|
-
# @!attribute [rw] states
|
412
|
-
# @return [Array<Google::Cloud::Bigquery::Datatransfer::V1::TransferState>]
|
413
|
-
# When specified, only transfer runs with requested states are returned.
|
414
|
-
# @!attribute [rw] page_token
|
415
|
-
# @return [String]
|
416
|
-
# Pagination token, which can be used to request a specific page
|
417
|
-
# of `ListTransferRunsRequest` list results. For multiple-page
|
418
|
-
# results, `ListTransferRunsResponse` outputs
|
419
|
-
# a `next_page` token, which can be used as the
|
420
|
-
# `page_token` value to request the next page of list results.
|
421
|
-
# @!attribute [rw] page_size
|
422
|
-
# @return [Integer]
|
423
|
-
# Page size. The default page size is the maximum value of 1000 results.
|
424
|
-
# @!attribute [rw] run_attempt
|
425
|
-
# @return [Google::Cloud::Bigquery::Datatransfer::V1::ListTransferRunsRequest::RunAttempt]
|
426
|
-
# Indicates how run attempts are to be pulled.
|
427
|
-
class ListTransferRunsRequest
|
428
|
-
# Represents which runs should be pulled.
|
429
|
-
module RunAttempt
|
430
|
-
# All runs should be returned.
|
431
|
-
RUN_ATTEMPT_UNSPECIFIED = 0
|
432
|
-
|
433
|
-
# Only latest run per day should be returned.
|
434
|
-
LATEST = 1
|
435
|
-
end
|
436
|
-
end
|
437
|
-
|
438
|
-
# The returned list of pipelines in the project.
|
439
|
-
# @!attribute [rw] transfer_runs
|
440
|
-
# @return [Array<Google::Cloud::Bigquery::Datatransfer::V1::TransferRun>]
|
441
|
-
# Output only. The stored pipeline transfer runs.
|
442
|
-
# @!attribute [rw] next_page_token
|
443
|
-
# @return [String]
|
444
|
-
# Output only. The next-pagination token. For multiple-page list results,
|
445
|
-
# this token can be used as the
|
446
|
-
# `ListTransferRunsRequest.page_token`
|
447
|
-
# to request the next page of list results.
|
448
|
-
class ListTransferRunsResponse; end
|
449
|
-
|
450
|
-
# A request to get user facing log messages associated with data transfer run.
|
451
|
-
# @!attribute [rw] parent
|
452
|
-
# @return [String]
|
453
|
-
# Required. Transfer run name in the form:
|
454
|
-
# `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
|
455
|
-
# `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
|
456
|
-
# @!attribute [rw] page_token
|
457
|
-
# @return [String]
|
458
|
-
# Pagination token, which can be used to request a specific page
|
459
|
-
# of `ListTransferLogsRequest` list results. For multiple-page
|
460
|
-
# results, `ListTransferLogsResponse` outputs
|
461
|
-
# a `next_page` token, which can be used as the
|
462
|
-
# `page_token` value to request the next page of list results.
|
463
|
-
# @!attribute [rw] page_size
|
464
|
-
# @return [Integer]
|
465
|
-
# Page size. The default page size is the maximum value of 1000 results.
|
466
|
-
# @!attribute [rw] message_types
|
467
|
-
# @return [Array<Google::Cloud::Bigquery::Datatransfer::V1::TransferMessage::MessageSeverity>]
|
468
|
-
# Message types to return. If not populated - INFO, WARNING and ERROR
|
469
|
-
# messages are returned.
|
470
|
-
class ListTransferLogsRequest; end
|
471
|
-
|
472
|
-
# The returned list transfer run messages.
|
473
|
-
# @!attribute [rw] transfer_messages
|
474
|
-
# @return [Array<Google::Cloud::Bigquery::Datatransfer::V1::TransferMessage>]
|
475
|
-
# Output only. The stored pipeline transfer messages.
|
476
|
-
# @!attribute [rw] next_page_token
|
477
|
-
# @return [String]
|
478
|
-
# Output only. The next-pagination token. For multiple-page list results,
|
479
|
-
# this token can be used as the
|
480
|
-
# `GetTransferRunLogRequest.page_token`
|
481
|
-
# to request the next page of list results.
|
482
|
-
class ListTransferLogsResponse; end
|
483
|
-
|
484
|
-
# A request to determine whether the user has valid credentials. This method
|
485
|
-
# is used to limit the number of OAuth popups in the user interface. The
|
486
|
-
# user id is inferred from the API call context.
|
487
|
-
# If the data source has the Google+ authorization type, this method
|
488
|
-
# returns false, as it cannot be determined whether the credentials are
|
489
|
-
# already valid merely based on the user id.
|
490
|
-
# @!attribute [rw] name
|
491
|
-
# @return [String]
|
492
|
-
# Required. The data source in the form:
|
493
|
-
# `projects/{project_id}/dataSources/{data_source_id}` or
|
494
|
-
# `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
|
495
|
-
class CheckValidCredsRequest; end
|
496
|
-
|
497
|
-
# A response indicating whether the credentials exist and are valid.
|
498
|
-
# @!attribute [rw] has_valid_creds
|
499
|
-
# @return [true, false]
|
500
|
-
# If set to `true`, the credentials exist and are valid.
|
501
|
-
class CheckValidCredsResponse; end
|
502
|
-
|
503
|
-
# A request to schedule transfer runs for a time range.
|
504
|
-
# @!attribute [rw] parent
|
505
|
-
# @return [String]
|
506
|
-
# Required. Transfer configuration name in the form:
|
507
|
-
# `projects/{project_id}/transferConfigs/{config_id}` or
|
508
|
-
# `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
|
509
|
-
# @!attribute [rw] start_time
|
510
|
-
# @return [Google::Protobuf::Timestamp]
|
511
|
-
# Required. Start time of the range of transfer runs. For example,
|
512
|
-
# `"2017-05-25T00:00:00+00:00"`.
|
513
|
-
# @!attribute [rw] end_time
|
514
|
-
# @return [Google::Protobuf::Timestamp]
|
515
|
-
# Required. End time of the range of transfer runs. For example,
|
516
|
-
# `"2017-05-30T00:00:00+00:00"`.
|
517
|
-
class ScheduleTransferRunsRequest; end
|
518
|
-
|
519
|
-
# A response to schedule transfer runs for a time range.
|
520
|
-
# @!attribute [rw] runs
|
521
|
-
# @return [Array<Google::Cloud::Bigquery::Datatransfer::V1::TransferRun>]
|
522
|
-
# The transfer runs that were scheduled.
|
523
|
-
class ScheduleTransferRunsResponse; end
|
524
|
-
|
525
|
-
# A request to start manual transfer runs.
|
526
|
-
# @!attribute [rw] parent
|
527
|
-
# @return [String]
|
528
|
-
# Transfer configuration name in the form:
|
529
|
-
# `projects/{project_id}/transferConfigs/{config_id}` or
|
530
|
-
# `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
|
531
|
-
# @!attribute [rw] requested_time_range
|
532
|
-
# @return [Google::Cloud::Bigquery::Datatransfer::V1::StartManualTransferRunsRequest::TimeRange]
|
533
|
-
# Time range for the transfer runs that should be started.
|
534
|
-
# @!attribute [rw] requested_run_time
|
535
|
-
# @return [Google::Protobuf::Timestamp]
|
536
|
-
# Specific run_time for a transfer run to be started. The
|
537
|
-
# requested_run_time must not be in the future.
|
538
|
-
class StartManualTransferRunsRequest
|
539
|
-
# A specification for a time range, this will request transfer runs with
|
540
|
-
# run_time between start_time (inclusive) and end_time (exclusive).
|
541
|
-
# @!attribute [rw] start_time
|
542
|
-
# @return [Google::Protobuf::Timestamp]
|
543
|
-
# Start time of the range of transfer runs. For example,
|
544
|
-
# `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than
|
545
|
-
# the end_time. Creates transfer runs where run_time is in the range betwen
|
546
|
-
# start_time (inclusive) and end_time (exlusive).
|
547
|
-
# @!attribute [rw] end_time
|
548
|
-
# @return [Google::Protobuf::Timestamp]
|
549
|
-
# End time of the range of transfer runs. For example,
|
550
|
-
# `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future.
|
551
|
-
# Creates transfer runs where run_time is in the range betwen start_time
|
552
|
-
# (inclusive) and end_time (exlusive).
|
553
|
-
class TimeRange; end
|
554
|
-
end
|
555
|
-
|
556
|
-
# A response to start manual transfer runs.
|
557
|
-
# @!attribute [rw] runs
|
558
|
-
# @return [Array<Google::Cloud::Bigquery::Datatransfer::V1::TransferRun>]
|
559
|
-
# The transfer runs that were created.
|
560
|
-
class StartManualTransferRunsResponse; end
|
561
|
-
end
|
562
|
-
end
|
563
|
-
end
|
564
|
-
end
|
565
|
-
end
|