google-cloud-bigquery-data_transfer-v1 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +203 -0
  5. data/README.md +71 -0
  6. data/lib/google-cloud-bigquery-data_transfer-v1.rb +21 -0
  7. data/lib/google/cloud/bigquery/data_transfer/v1.rb +37 -0
  8. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service.rb +54 -0
  9. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb +1567 -0
  10. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/credentials.rb +53 -0
  11. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/paths.rb +193 -0
  12. data/lib/google/cloud/bigquery/data_transfer/v1/version.rb +30 -0
  13. data/lib/google/cloud/bigquery/datatransfer/v1/datatransfer_pb.rb +217 -0
  14. data/lib/google/cloud/bigquery/datatransfer/v1/datatransfer_services_pb.rb +92 -0
  15. data/lib/google/cloud/bigquery/datatransfer/v1/transfer_pb.rb +104 -0
  16. data/lib/google/cloud/common_resources_pb.rb +15 -0
  17. data/proto_docs/README.md +4 -0
  18. data/proto_docs/google/api/field_behavior.rb +59 -0
  19. data/proto_docs/google/api/resource.rb +247 -0
  20. data/proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb +646 -0
  21. data/proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb +276 -0
  22. data/proto_docs/google/protobuf/any.rb +138 -0
  23. data/proto_docs/google/protobuf/duration.rb +98 -0
  24. data/proto_docs/google/protobuf/empty.rb +36 -0
  25. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  26. data/proto_docs/google/protobuf/struct.rb +96 -0
  27. data/proto_docs/google/protobuf/timestamp.rb +120 -0
  28. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  29. data/proto_docs/google/rpc/status.rb +46 -0
  30. metadata +183 -0
@@ -0,0 +1,646 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Bigquery
23
+ module DataTransfer
24
+ module V1
25
+ # Represents a data source parameter with validation rules, so that
26
+ # parameters can be rendered in the UI. These parameters are given to us by
27
+ # supported data sources, and include all needed information for rendering
28
+ # and validation.
29
+ # Thus, whoever uses this api can decide to generate either generic ui,
30
+ # or custom data source specific forms.
31
+ # @!attribute [rw] param_id
32
+ # @return [String]
33
+ # Parameter identifier.
34
+ # @!attribute [rw] display_name
35
+ # @return [String]
36
+ # Parameter display name in the user interface.
37
+ # @!attribute [rw] description
38
+ # @return [String]
39
+ # Parameter description.
40
+ # @!attribute [rw] type
41
+ # @return [Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter::Type]
42
+ # Parameter type.
43
+ # @!attribute [rw] required
44
+ # @return [Boolean]
45
+ # Is parameter required.
46
+ # @!attribute [rw] repeated
47
+ # @return [Boolean]
48
+ # Deprecated. This field has no effect.
49
+ # @!attribute [rw] validation_regex
50
+ # @return [String]
51
+ # Regular expression which can be used for parameter validation.
52
+ # @!attribute [rw] allowed_values
53
+ # @return [Array<String>]
54
+ # All possible values for the parameter.
55
+ # @!attribute [rw] min_value
56
+ # @return [Google::Protobuf::DoubleValue]
57
+ # For integer and double values specifies minimum allowed value.
58
+ # @!attribute [rw] max_value
59
+ # @return [Google::Protobuf::DoubleValue]
60
+ # For integer and double values specifies maxminum allowed value.
61
+ # @!attribute [rw] fields
62
+ # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>]
63
+ # Deprecated. This field has no effect.
64
+ # @!attribute [rw] validation_description
65
+ # @return [String]
66
+ # Description of the requirements for this field, in case the user input does
67
+ # not fulfill the regex pattern or min/max values.
68
+ # @!attribute [rw] validation_help_url
69
+ # @return [String]
70
+ # URL to a help document to further explain the naming requirements.
71
+ # @!attribute [rw] immutable
72
+ # @return [Boolean]
73
+ # Cannot be changed after initial creation.
74
+ # @!attribute [rw] recurse
75
+ # @return [Boolean]
76
+ # Deprecated. This field has no effect.
77
+ # @!attribute [rw] deprecated
78
+ # @return [Boolean]
79
+ # If true, it should not be used in new transfers, and it should not be
80
+ # visible to users.
81
+ class DataSourceParameter
82
+ include Google::Protobuf::MessageExts
83
+ extend Google::Protobuf::MessageExts::ClassMethods
84
+
85
+ # Parameter type.
86
+ module Type
87
+ # Type unspecified.
88
+ TYPE_UNSPECIFIED = 0
89
+
90
+ # String parameter.
91
+ STRING = 1
92
+
93
+ # Integer parameter (64-bits).
94
+ # Will be serialized to json as string.
95
+ INTEGER = 2
96
+
97
+ # Double precision floating point parameter.
98
+ DOUBLE = 3
99
+
100
+ # Boolean parameter.
101
+ BOOLEAN = 4
102
+
103
+ # Deprecated. This field has no effect.
104
+ RECORD = 5
105
+
106
+ # Page ID for a Google+ Page.
107
+ PLUS_PAGE = 6
108
+ end
109
+ end
110
+
111
+ # Represents data source metadata. Metadata is sufficient to
112
+ # render UI and request proper OAuth tokens.
113
+ # @!attribute [r] name
114
+ # @return [String]
115
+ # Output only. Data source resource name.
116
+ # @!attribute [rw] data_source_id
117
+ # @return [String]
118
+ # Data source id.
119
+ # @!attribute [rw] display_name
120
+ # @return [String]
121
+ # User friendly data source name.
122
+ # @!attribute [rw] description
123
+ # @return [String]
124
+ # User friendly data source description string.
125
+ # @!attribute [rw] client_id
126
+ # @return [String]
127
+ # Data source client id which should be used to receive refresh token.
128
+ # @!attribute [rw] scopes
129
+ # @return [Array<String>]
130
+ # Api auth scopes for which refresh token needs to be obtained. These are
131
+ # scopes needed by a data source to prepare data and ingest them into
132
+ # BigQuery, e.g., https://www.googleapis.com/auth/bigquery
133
+ # @!attribute [rw] transfer_type
134
+ # @return [Google::Cloud::Bigquery::DataTransfer::V1::TransferType]
135
+ # Deprecated. This field has no effect.
136
+ # @!attribute [rw] supports_multiple_transfers
137
+ # @return [Boolean]
138
+ # Deprecated. This field has no effect.
139
+ # @!attribute [rw] update_deadline_seconds
140
+ # @return [Integer]
141
+ # The number of seconds to wait for an update from the data source
142
+ # before the Data Transfer Service marks the transfer as FAILED.
143
+ # @!attribute [rw] default_schedule
144
+ # @return [String]
145
+ # Default data transfer schedule.
146
+ # Examples of valid schedules include:
147
+ # `1st,3rd monday of month 15:30`,
148
+ # `every wed,fri of jan,jun 13:15`, and
149
+ # `first sunday of quarter 00:00`.
150
+ # @!attribute [rw] supports_custom_schedule
151
+ # @return [Boolean]
152
+ # Specifies whether the data source supports a user defined schedule, or
153
+ # operates on the default schedule.
154
+ # When set to `true`, user can override default schedule.
155
+ # @!attribute [rw] parameters
156
+ # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>]
157
+ # Data source parameters.
158
+ # @!attribute [rw] help_url
159
+ # @return [String]
160
+ # Url for the help document for this data source.
161
+ # @!attribute [rw] authorization_type
162
+ # @return [Google::Cloud::Bigquery::DataTransfer::V1::DataSource::AuthorizationType]
163
+ # Indicates the type of authorization.
164
+ # @!attribute [rw] data_refresh_type
165
+ # @return [Google::Cloud::Bigquery::DataTransfer::V1::DataSource::DataRefreshType]
166
+ # Specifies whether the data source supports automatic data refresh for the
167
+ # past few days, and how it's supported.
168
+ # For some data sources, data might not be complete until a few days later,
169
+ # so it's useful to refresh data automatically.
170
+ # @!attribute [rw] default_data_refresh_window_days
171
+ # @return [Integer]
172
+ # Default data refresh window on days.
173
+ # Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
174
+ # @!attribute [rw] manual_runs_disabled
175
+ # @return [Boolean]
176
+ # Disables backfilling and manual run scheduling
177
+ # for the data source.
178
+ # @!attribute [rw] minimum_schedule_interval
179
+ # @return [Google::Protobuf::Duration]
180
+ # The minimum interval for scheduler to schedule runs.
181
+ class DataSource
182
+ include Google::Protobuf::MessageExts
183
+ extend Google::Protobuf::MessageExts::ClassMethods
184
+
185
+ # The type of authorization needed for this data source.
186
+ module AuthorizationType
187
+ # Type unspecified.
188
+ AUTHORIZATION_TYPE_UNSPECIFIED = 0
189
+
190
+ # Use OAuth 2 authorization codes that can be exchanged
191
+ # for a refresh token on the backend.
192
+ AUTHORIZATION_CODE = 1
193
+
194
+ # Return an authorization code for a given Google+ page that can then be
195
+ # exchanged for a refresh token on the backend.
196
+ GOOGLE_PLUS_AUTHORIZATION_CODE = 2
197
+
198
+ # Use First Party Client OAuth. First Party Client OAuth doesn't require a
199
+ # refresh token to get an offline access token. Instead, it uses a
200
+ # client-signed JWT assertion to retrieve an access token.
201
+ FIRST_PARTY_OAUTH = 3
202
+ end
203
+
204
+ # Represents how the data source supports data auto refresh.
205
+ module DataRefreshType
206
+ # The data source won't support data auto refresh, which is default value.
207
+ DATA_REFRESH_TYPE_UNSPECIFIED = 0
208
+
209
+ # The data source supports data auto refresh, and runs will be scheduled
210
+ # for the past few days. Does not allow custom values to be set for each
211
+ # transfer config.
212
+ SLIDING_WINDOW = 1
213
+
214
+ # The data source supports data auto refresh, and runs will be scheduled
215
+ # for the past few days. Allows custom values to be set for each transfer
216
+ # config.
217
+ CUSTOM_SLIDING_WINDOW = 2
218
+ end
219
+ end
220
+
221
+ # A request to get data source info.
222
+ # @!attribute [rw] name
223
+ # @return [String]
224
+ # Required. The field will contain name of the resource requested, for example:
225
+ # `projects/{project_id}/dataSources/{data_source_id}` or
226
+ # `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
227
+ class GetDataSourceRequest
228
+ include Google::Protobuf::MessageExts
229
+ extend Google::Protobuf::MessageExts::ClassMethods
230
+ end
231
+
232
+ # Request to list supported data sources and their data transfer settings.
233
+ # @!attribute [rw] parent
234
+ # @return [String]
235
+ # Required. The BigQuery project id for which data sources should be returned.
236
+ # Must be in the form: `projects/{project_id}` or
237
+ # `projects/{project_id}/locations/{location_id}
238
+ # @!attribute [rw] page_token
239
+ # @return [String]
240
+ # Pagination token, which can be used to request a specific page
241
+ # of `ListDataSourcesRequest` list results. For multiple-page
242
+ # results, `ListDataSourcesResponse` outputs
243
+ # a `next_page` token, which can be used as the
244
+ # `page_token` value to request the next page of list results.
245
+ # @!attribute [rw] page_size
246
+ # @return [Integer]
247
+ # Page size. The default page size is the maximum value of 1000 results.
248
+ class ListDataSourcesRequest
249
+ include Google::Protobuf::MessageExts
250
+ extend Google::Protobuf::MessageExts::ClassMethods
251
+ end
252
+
253
+ # Returns list of supported data sources and their metadata.
254
+ # @!attribute [rw] data_sources
255
+ # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::DataSource>]
256
+ # List of supported data sources and their transfer settings.
257
+ # @!attribute [r] next_page_token
258
+ # @return [String]
259
+ # Output only. The next-pagination token. For multiple-page list results,
260
+ # this token can be used as the
261
+ # `ListDataSourcesRequest.page_token`
262
+ # to request the next page of list results.
263
+ class ListDataSourcesResponse
264
+ include Google::Protobuf::MessageExts
265
+ extend Google::Protobuf::MessageExts::ClassMethods
266
+ end
267
+
268
+ # A request to create a data transfer configuration. If new credentials are
269
+ # needed for this transfer configuration, an authorization code must be
270
+ # provided. If an authorization code is provided, the transfer configuration
271
+ # will be associated with the user id corresponding to the
272
+ # authorization code. Otherwise, the transfer configuration will be associated
273
+ # with the calling user.
274
+ # @!attribute [rw] parent
275
+ # @return [String]
276
+ # Required. The BigQuery project id where the transfer configuration should be created.
277
+ # Must be in the format projects/\\{project_id}/locations/\\{location_id} or
278
+ # projects/\\{project_id}. If specified location and location of the
279
+ # destination bigquery dataset do not match - the request will fail.
280
+ # @!attribute [rw] transfer_config
281
+ # @return [Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
282
+ # Required. Data transfer configuration to create.
283
+ # @!attribute [rw] authorization_code
284
+ # @return [String]
285
+ # Optional OAuth2 authorization code to use with this transfer configuration.
286
+ # This is required if new credentials are needed, as indicated by
287
+ # `CheckValidCreds`.
288
+ # In order to obtain authorization_code, please make a
289
+ # request to
290
+ # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
291
+ #
292
+ # * client_id should be OAuth client_id of BigQuery DTS API for the given
293
+ # data source returned by ListDataSources method.
294
+ # * data_source_scopes are the scopes returned by ListDataSources method.
295
+ # * redirect_uri is an optional parameter. If not specified, then
296
+ # authorization code is posted to the opener of authorization flow window.
297
+ # Otherwise it will be sent to the redirect uri. A special value of
298
+ # urn:ietf:wg:oauth:2.0:oob means that authorization code should be
299
+ # returned in the title bar of the browser, with the page text prompting
300
+ # the user to copy the code and paste it in the application.
301
+ # @!attribute [rw] version_info
302
+ # @return [String]
303
+ # Optional version info. If users want to find a very recent access token,
304
+ # that is, immediately after approving access, users have to set the
305
+ # version_info claim in the token request. To obtain the version_info, users
306
+ # must use the "none+gsession" response type. which be return a
307
+ # version_info back in the authorization response which be be put in a JWT
308
+ # claim in the token request.
309
+ # @!attribute [rw] service_account_name
310
+ # @return [String]
311
+ # Optional service account name. If this field is set, transfer config will
312
+ # be created with this service account credentials. It requires that
313
+ # requesting user calling this API has permissions to act as this service
314
+ # account.
315
+ class CreateTransferConfigRequest
316
+ include Google::Protobuf::MessageExts
317
+ extend Google::Protobuf::MessageExts::ClassMethods
318
+ end
319
+
320
+ # A request to update a transfer configuration. To update the user id of the
321
+ # transfer configuration, an authorization code needs to be provided.
322
+ # @!attribute [rw] transfer_config
323
+ # @return [Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
324
+ # Required. Data transfer configuration to create.
325
+ # @!attribute [rw] authorization_code
326
+ # @return [String]
327
+ # Optional OAuth2 authorization code to use with this transfer configuration.
328
+ # If it is provided, the transfer configuration will be associated with the
329
+ # authorizing user.
330
+ # In order to obtain authorization_code, please make a
331
+ # request to
332
+ # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
333
+ #
334
+ # * client_id should be OAuth client_id of BigQuery DTS API for the given
335
+ # data source returned by ListDataSources method.
336
+ # * data_source_scopes are the scopes returned by ListDataSources method.
337
+ # * redirect_uri is an optional parameter. If not specified, then
338
+ # authorization code is posted to the opener of authorization flow window.
339
+ # Otherwise it will be sent to the redirect uri. A special value of
340
+ # urn:ietf:wg:oauth:2.0:oob means that authorization code should be
341
+ # returned in the title bar of the browser, with the page text prompting
342
+ # the user to copy the code and paste it in the application.
343
+ # @!attribute [rw] update_mask
344
+ # @return [Google::Protobuf::FieldMask]
345
+ # Required. Required list of fields to be updated in this request.
346
+ # @!attribute [rw] version_info
347
+ # @return [String]
348
+ # Optional version info. If users want to find a very recent access token,
349
+ # that is, immediately after approving access, users have to set the
350
+ # version_info claim in the token request. To obtain the version_info, users
351
+ # must use the "none+gsession" response type. which be return a
352
+ # version_info back in the authorization response which be be put in a JWT
353
+ # claim in the token request.
354
+ # @!attribute [rw] service_account_name
355
+ # @return [String]
356
+ # Optional service account name. If this field is set and
357
+ # "service_account_name" is set in update_mask, transfer config will be
358
+ # updated to use this service account credentials. It requires that
359
+ # requesting user calling this API has permissions to act as this service
360
+ # account.
361
+ class UpdateTransferConfigRequest
362
+ include Google::Protobuf::MessageExts
363
+ extend Google::Protobuf::MessageExts::ClassMethods
364
+ end
365
+
366
+ # A request to get data transfer information.
367
+ # @!attribute [rw] name
368
+ # @return [String]
369
+ # Required. The field will contain name of the resource requested, for example:
370
+ # `projects/{project_id}/transferConfigs/{config_id}` or
371
+ # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
372
+ class GetTransferConfigRequest
373
+ include Google::Protobuf::MessageExts
374
+ extend Google::Protobuf::MessageExts::ClassMethods
375
+ end
376
+
377
+ # A request to delete data transfer information. All associated transfer runs
378
+ # and log messages will be deleted as well.
379
+ # @!attribute [rw] name
380
+ # @return [String]
381
+ # Required. The field will contain name of the resource requested, for example:
382
+ # `projects/{project_id}/transferConfigs/{config_id}` or
383
+ # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
384
+ class DeleteTransferConfigRequest
385
+ include Google::Protobuf::MessageExts
386
+ extend Google::Protobuf::MessageExts::ClassMethods
387
+ end
388
+
389
+ # A request to get data transfer run information.
390
+ # @!attribute [rw] name
391
+ # @return [String]
392
+ # Required. The field will contain name of the resource requested, for example:
393
+ # `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
394
+ # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
395
+ class GetTransferRunRequest
396
+ include Google::Protobuf::MessageExts
397
+ extend Google::Protobuf::MessageExts::ClassMethods
398
+ end
399
+
400
+ # A request to delete data transfer run information.
401
+ # @!attribute [rw] name
402
+ # @return [String]
403
+ # Required. The field will contain name of the resource requested, for example:
404
+ # `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
405
+ # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
406
+ class DeleteTransferRunRequest
407
+ include Google::Protobuf::MessageExts
408
+ extend Google::Protobuf::MessageExts::ClassMethods
409
+ end
410
+
411
+ # A request to list data transfers configured for a BigQuery project.
412
+ # @!attribute [rw] parent
413
+ # @return [String]
414
+ # Required. The BigQuery project id for which data sources
415
+ # should be returned: `projects/{project_id}` or
416
+ # `projects/{project_id}/locations/{location_id}`
417
+ # @!attribute [rw] data_source_ids
418
+ # @return [Array<String>]
419
+ # When specified, only configurations of requested data sources are returned.
420
+ # @!attribute [rw] page_token
421
+ # @return [String]
422
+ # Pagination token, which can be used to request a specific page
423
+ # of `ListTransfersRequest` list results. For multiple-page
424
+ # results, `ListTransfersResponse` outputs
425
+ # a `next_page` token, which can be used as the
426
+ # `page_token` value to request the next page of list results.
427
+ # @!attribute [rw] page_size
428
+ # @return [Integer]
429
+ # Page size. The default page size is the maximum value of 1000 results.
430
+ class ListTransferConfigsRequest
431
+ include Google::Protobuf::MessageExts
432
+ extend Google::Protobuf::MessageExts::ClassMethods
433
+ end
434
+
435
+ # The returned list of pipelines in the project.
436
+ # @!attribute [r] transfer_configs
437
+ # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig>]
438
+ # Output only. The stored pipeline transfer configurations.
439
+ # @!attribute [r] next_page_token
440
+ # @return [String]
441
+ # Output only. The next-pagination token. For multiple-page list results,
442
+ # this token can be used as the
443
+ # `ListTransferConfigsRequest.page_token`
444
+ # to request the next page of list results.
445
+ class ListTransferConfigsResponse
446
+ include Google::Protobuf::MessageExts
447
+ extend Google::Protobuf::MessageExts::ClassMethods
448
+ end
449
+
450
+ # A request to list data transfer runs. UI can use this method to show/filter
451
+ # specific data transfer runs. The data source can use this method to request
452
+ # all scheduled transfer runs.
453
+ # @!attribute [rw] parent
454
+ # @return [String]
455
+ # Required. Name of transfer configuration for which transfer runs should be retrieved.
456
+ # Format of transfer configuration resource name is:
457
+ # `projects/{project_id}/transferConfigs/{config_id}` or
458
+ # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
459
+ # @!attribute [rw] states
460
+ # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferState>]
461
+ # When specified, only transfer runs with requested states are returned.
462
+ # @!attribute [rw] page_token
463
+ # @return [String]
464
+ # Pagination token, which can be used to request a specific page
465
+ # of `ListTransferRunsRequest` list results. For multiple-page
466
+ # results, `ListTransferRunsResponse` outputs
467
+ # a `next_page` token, which can be used as the
468
+ # `page_token` value to request the next page of list results.
469
+ # @!attribute [rw] page_size
470
+ # @return [Integer]
471
+ # Page size. The default page size is the maximum value of 1000 results.
472
+ # @!attribute [rw] run_attempt
473
+ # @return [Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest::RunAttempt]
474
+ # Indicates how run attempts are to be pulled.
475
+ class ListTransferRunsRequest
476
+ include Google::Protobuf::MessageExts
477
+ extend Google::Protobuf::MessageExts::ClassMethods
478
+
479
+ # Represents which runs should be pulled.
480
+ module RunAttempt
481
+ # All runs should be returned.
482
+ RUN_ATTEMPT_UNSPECIFIED = 0
483
+
484
+ # Only latest run per day should be returned.
485
+ LATEST = 1
486
+ end
487
+ end
488
+
489
+ # The returned list of pipelines in the project.
490
+ # @!attribute [r] transfer_runs
491
+ # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>]
492
+ # Output only. The stored pipeline transfer runs.
493
+ # @!attribute [r] next_page_token
494
+ # @return [String]
495
+ # Output only. The next-pagination token. For multiple-page list results,
496
+ # this token can be used as the
497
+ # `ListTransferRunsRequest.page_token`
498
+ # to request the next page of list results.
499
+ class ListTransferRunsResponse
500
+ include Google::Protobuf::MessageExts
501
+ extend Google::Protobuf::MessageExts::ClassMethods
502
+ end
503
+
504
+ # A request to get user facing log messages associated with data transfer run.
505
+ # @!attribute [rw] parent
506
+ # @return [String]
507
+ # Required. Transfer run name in the form:
508
+ # `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
509
+ # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
510
+ # @!attribute [rw] page_token
511
+ # @return [String]
512
+ # Pagination token, which can be used to request a specific page
513
+ # of `ListTransferLogsRequest` list results. For multiple-page
514
+ # results, `ListTransferLogsResponse` outputs
515
+ # a `next_page` token, which can be used as the
516
+ # `page_token` value to request the next page of list results.
517
+ # @!attribute [rw] page_size
518
+ # @return [Integer]
519
+ # Page size. The default page size is the maximum value of 1000 results.
520
+ # @!attribute [rw] message_types
521
+ # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage::MessageSeverity>]
522
+ # Message types to return. If not populated - INFO, WARNING and ERROR
523
+ # messages are returned.
524
+ class ListTransferLogsRequest
525
+ include Google::Protobuf::MessageExts
526
+ extend Google::Protobuf::MessageExts::ClassMethods
527
+ end
528
+
529
+ # The returned list transfer run messages.
530
+ # @!attribute [r] transfer_messages
531
+ # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage>]
532
+ # Output only. The stored pipeline transfer messages.
533
+ # @!attribute [r] next_page_token
534
+ # @return [String]
535
+ # Output only. The next-pagination token. For multiple-page list results,
536
+ # this token can be used as the
537
+ # `GetTransferRunLogRequest.page_token`
538
+ # to request the next page of list results.
539
+ class ListTransferLogsResponse
540
+ include Google::Protobuf::MessageExts
541
+ extend Google::Protobuf::MessageExts::ClassMethods
542
+ end
543
+
544
+ # A request to determine whether the user has valid credentials. This method
545
+ # is used to limit the number of OAuth popups in the user interface. The
546
+ # user id is inferred from the API call context.
547
+ # If the data source has the Google+ authorization type, this method
548
+ # returns false, as it cannot be determined whether the credentials are
549
+ # already valid merely based on the user id.
550
+ # @!attribute [rw] name
551
+ # @return [String]
552
+ # Required. The data source in the form:
553
+ # `projects/{project_id}/dataSources/{data_source_id}` or
554
+ # `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
555
+ class CheckValidCredsRequest
556
+ include Google::Protobuf::MessageExts
557
+ extend Google::Protobuf::MessageExts::ClassMethods
558
+ end
559
+
560
+ # A response indicating whether the credentials exist and are valid.
561
+ # @!attribute [rw] has_valid_creds
562
+ # @return [Boolean]
563
+ # If set to `true`, the credentials exist and are valid.
564
+ class CheckValidCredsResponse
565
+ include Google::Protobuf::MessageExts
566
+ extend Google::Protobuf::MessageExts::ClassMethods
567
+ end
568
+
569
+ # A request to schedule transfer runs for a time range.
570
+ # @!attribute [rw] parent
571
+ # @return [String]
572
+ # Required. Transfer configuration name in the form:
573
+ # `projects/{project_id}/transferConfigs/{config_id}` or
574
+ # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
575
+ # @!attribute [rw] start_time
576
+ # @return [Google::Protobuf::Timestamp]
577
+ # Required. Start time of the range of transfer runs. For example,
578
+ # `"2017-05-25T00:00:00+00:00"`.
579
+ # @!attribute [rw] end_time
580
+ # @return [Google::Protobuf::Timestamp]
581
+ # Required. End time of the range of transfer runs. For example,
582
+ # `"2017-05-30T00:00:00+00:00"`.
583
+ class ScheduleTransferRunsRequest
584
+ include Google::Protobuf::MessageExts
585
+ extend Google::Protobuf::MessageExts::ClassMethods
586
+ end
587
+
588
+ # A response to schedule transfer runs for a time range.
589
+ # @!attribute [rw] runs
590
+ # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>]
591
+ # The transfer runs that were scheduled.
592
+ class ScheduleTransferRunsResponse
593
+ include Google::Protobuf::MessageExts
594
+ extend Google::Protobuf::MessageExts::ClassMethods
595
+ end
596
+
597
+ # A request to start manual transfer runs.
598
+ # @!attribute [rw] parent
599
+ # @return [String]
600
+ # Transfer configuration name in the form:
601
+ # `projects/{project_id}/transferConfigs/{config_id}` or
602
+ # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
603
+ # @!attribute [rw] requested_time_range
604
+ # @return [Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsRequest::TimeRange]
605
+ # Time range for the transfer runs that should be started.
606
+ # @!attribute [rw] requested_run_time
607
+ # @return [Google::Protobuf::Timestamp]
608
+ # Specific run_time for a transfer run to be started. The
609
+ # requested_run_time must not be in the future.
610
+ class StartManualTransferRunsRequest
611
+ include Google::Protobuf::MessageExts
612
+ extend Google::Protobuf::MessageExts::ClassMethods
613
+
614
+ # A specification for a time range, this will request transfer runs with
615
+ # run_time between start_time (inclusive) and end_time (exclusive).
616
+ # @!attribute [rw] start_time
617
+ # @return [Google::Protobuf::Timestamp]
618
+ # Start time of the range of transfer runs. For example,
619
+ # `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than
620
+ # the end_time. Creates transfer runs where run_time is in the range betwen
621
+ # start_time (inclusive) and end_time (exlusive).
622
+ # @!attribute [rw] end_time
623
+ # @return [Google::Protobuf::Timestamp]
624
+ # End time of the range of transfer runs. For example,
625
+ # `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future.
626
+ # Creates transfer runs where run_time is in the range betwen start_time
627
+ # (inclusive) and end_time (exlusive).
628
+ class TimeRange
629
+ include Google::Protobuf::MessageExts
630
+ extend Google::Protobuf::MessageExts::ClassMethods
631
+ end
632
+ end
633
+
634
+ # A response to start manual transfer runs.
635
+ # @!attribute [rw] runs
636
+ # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>]
637
+ # The transfer runs that were created.
638
+ class StartManualTransferRunsResponse
639
+ include Google::Protobuf::MessageExts
640
+ extend Google::Protobuf::MessageExts::ClassMethods
641
+ end
642
+ end
643
+ end
644
+ end
645
+ end
646
+ end