-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
datatransfer.proto
896 lines (771 loc) · 34.1 KB
/
datatransfer.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.bigquery.datatransfer.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/bigquery/datatransfer/v1/transfer.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.BigQuery.DataTransfer.V1";
option go_package = "cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb;datatransferpb";
option java_multiple_files = true;
option java_outer_classname = "DataTransferProto";
option java_package = "com.google.cloud.bigquery.datatransfer.v1";
option php_namespace = "Google\\Cloud\\BigQuery\\DataTransfer\\V1";
option ruby_package = "Google::Cloud::Bigquery::DataTransfer::V1";
// This API allows users to manage their data transfers into BigQuery.
service DataTransferService {
option (google.api.default_host) = "bigquerydatatransfer.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Retrieves a supported data source and returns its settings.
rpc GetDataSource(GetDataSourceRequest) returns (DataSource) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/dataSources/*}"
additional_bindings { get: "/v1/{name=projects/*/dataSources/*}" }
};
option (google.api.method_signature) = "name";
}
// Lists supported data sources and returns their settings.
rpc ListDataSources(ListDataSourcesRequest)
returns (ListDataSourcesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/dataSources"
additional_bindings { get: "/v1/{parent=projects/*}/dataSources" }
};
option (google.api.method_signature) = "parent";
}
// Creates a new data transfer configuration.
rpc CreateTransferConfig(CreateTransferConfigRequest)
returns (TransferConfig) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/transferConfigs"
body: "transfer_config"
additional_bindings {
post: "/v1/{parent=projects/*}/transferConfigs"
body: "transfer_config"
}
};
option (google.api.method_signature) = "parent,transfer_config";
}
// Updates a data transfer configuration.
// All fields must be set, even if they are not updated.
rpc UpdateTransferConfig(UpdateTransferConfigRequest)
returns (TransferConfig) {
option (google.api.http) = {
patch: "/v1/{transfer_config.name=projects/*/locations/*/transferConfigs/*}"
body: "transfer_config"
additional_bindings {
patch: "/v1/{transfer_config.name=projects/*/transferConfigs/*}"
body: "transfer_config"
}
};
option (google.api.method_signature) = "transfer_config,update_mask";
}
// Deletes a data transfer configuration, including any associated transfer
// runs and logs.
rpc DeleteTransferConfig(DeleteTransferConfigRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/transferConfigs/*}"
additional_bindings { delete: "/v1/{name=projects/*/transferConfigs/*}" }
};
option (google.api.method_signature) = "name";
}
// Returns information about a data transfer config.
rpc GetTransferConfig(GetTransferConfigRequest) returns (TransferConfig) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/transferConfigs/*}"
additional_bindings { get: "/v1/{name=projects/*/transferConfigs/*}" }
};
option (google.api.method_signature) = "name";
}
// Returns information about all transfer configs owned by a project in the
// specified location.
rpc ListTransferConfigs(ListTransferConfigsRequest)
returns (ListTransferConfigsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/transferConfigs"
additional_bindings { get: "/v1/{parent=projects/*}/transferConfigs" }
};
option (google.api.method_signature) = "parent";
}
// Creates transfer runs for a time range [start_time, end_time].
// For each date - or whatever granularity the data source supports - in the
// range, one transfer run is created.
// Note that runs are created per UTC time in the time range.
// DEPRECATED: use StartManualTransferRuns instead.
rpc ScheduleTransferRuns(ScheduleTransferRunsRequest)
returns (ScheduleTransferRunsResponse) {
option deprecated = true;
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/transferConfigs/*}:scheduleRuns"
body: "*"
additional_bindings {
post: "/v1/{parent=projects/*/transferConfigs/*}:scheduleRuns"
body: "*"
}
};
option (google.api.method_signature) = "parent,start_time,end_time";
}
// Start manual transfer runs to be executed now with schedule_time equal to
// current time. The transfer runs can be created for a time range where the
// run_time is between start_time (inclusive) and end_time (exclusive), or for
// a specific run_time.
rpc StartManualTransferRuns(StartManualTransferRunsRequest)
returns (StartManualTransferRunsResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/transferConfigs/*}:startManualRuns"
body: "*"
additional_bindings {
post: "/v1/{parent=projects/*/transferConfigs/*}:startManualRuns"
body: "*"
}
};
}
// Returns information about the particular transfer run.
rpc GetTransferRun(GetTransferRunRequest) returns (TransferRun) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/transferConfigs/*/runs/*}"
additional_bindings {
get: "/v1/{name=projects/*/transferConfigs/*/runs/*}"
}
};
option (google.api.method_signature) = "name";
}
// Deletes the specified transfer run.
rpc DeleteTransferRun(DeleteTransferRunRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/transferConfigs/*/runs/*}"
additional_bindings {
delete: "/v1/{name=projects/*/transferConfigs/*/runs/*}"
}
};
option (google.api.method_signature) = "name";
}
// Returns information about running and completed transfer runs.
rpc ListTransferRuns(ListTransferRunsRequest)
returns (ListTransferRunsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/transferConfigs/*}/runs"
additional_bindings {
get: "/v1/{parent=projects/*/transferConfigs/*}/runs"
}
};
option (google.api.method_signature) = "parent";
}
// Returns log messages for the transfer run.
rpc ListTransferLogs(ListTransferLogsRequest)
returns (ListTransferLogsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/transferConfigs/*/runs/*}/transferLogs"
additional_bindings {
get: "/v1/{parent=projects/*/transferConfigs/*/runs/*}/transferLogs"
}
};
option (google.api.method_signature) = "parent";
}
// Returns true if valid credentials exist for the given data source and
// requesting user.
rpc CheckValidCreds(CheckValidCredsRequest)
returns (CheckValidCredsResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/dataSources/*}:checkValidCreds"
body: "*"
additional_bindings {
post: "/v1/{name=projects/*/dataSources/*}:checkValidCreds"
body: "*"
}
};
option (google.api.method_signature) = "name";
}
// Enroll data sources in a user project. This allows users to create transfer
// configurations for these data sources. They will also appear in the
// ListDataSources RPC and as such, will appear in the
// [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents
// can be found in the public guide for
// [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and
// [Data Transfer
// Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
rpc EnrollDataSources(EnrollDataSourcesRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*}:enrollDataSources"
body: "*"
additional_bindings {
post: "/v1/{name=projects/*}:enrollDataSources"
body: "*"
}
};
}
}
// A parameter used to define custom fields in a data source definition.
message DataSourceParameter {
// Parameter type.
enum Type {
// Type unspecified.
TYPE_UNSPECIFIED = 0;
// String parameter.
STRING = 1;
// Integer parameter (64-bits).
// Will be serialized to json as string.
INTEGER = 2;
// Double precision floating point parameter.
DOUBLE = 3;
// Boolean parameter.
BOOLEAN = 4;
// Deprecated. This field has no effect.
RECORD = 5;
// Page ID for a Google+ Page.
PLUS_PAGE = 6;
// List of strings parameter.
LIST = 7;
}
// Parameter identifier.
string param_id = 1;
// Parameter display name in the user interface.
string display_name = 2;
// Parameter description.
string description = 3;
// Parameter type.
Type type = 4;
// Is parameter required.
bool required = 5;
// Deprecated. This field has no effect.
bool repeated = 6;
// Regular expression which can be used for parameter validation.
string validation_regex = 7;
// All possible values for the parameter.
repeated string allowed_values = 8;
// For integer and double values specifies minimum allowed value.
google.protobuf.DoubleValue min_value = 9;
// For integer and double values specifies maximum allowed value.
google.protobuf.DoubleValue max_value = 10;
// Deprecated. This field has no effect.
repeated DataSourceParameter fields = 11;
// Description of the requirements for this field, in case the user input does
// not fulfill the regex pattern or min/max values.
string validation_description = 12;
// URL to a help document to further explain the naming requirements.
string validation_help_url = 13;
// Cannot be changed after initial creation.
bool immutable = 14;
// Deprecated. This field has no effect.
bool recurse = 15;
// If true, it should not be used in new transfers, and it should not be
// visible to users.
bool deprecated = 20;
}
// Defines the properties and custom parameters for a data source.
message DataSource {
option (google.api.resource) = {
type: "bigquerydatatransfer.googleapis.com/DataSource"
pattern: "projects/{project}/dataSources/{data_source}"
pattern: "projects/{project}/locations/{location}/dataSources/{data_source}"
};
// The type of authorization needed for this data source.
enum AuthorizationType {
// Type unspecified.
AUTHORIZATION_TYPE_UNSPECIFIED = 0;
// Use OAuth 2 authorization codes that can be exchanged
// for a refresh token on the backend.
AUTHORIZATION_CODE = 1;
// Return an authorization code for a given Google+ page that can then be
// exchanged for a refresh token on the backend.
GOOGLE_PLUS_AUTHORIZATION_CODE = 2;
// Use First Party OAuth.
FIRST_PARTY_OAUTH = 3;
}
// Represents how the data source supports data auto refresh.
enum DataRefreshType {
// The data source won't support data auto refresh, which is default value.
DATA_REFRESH_TYPE_UNSPECIFIED = 0;
// The data source supports data auto refresh, and runs will be scheduled
// for the past few days. Does not allow custom values to be set for each
// transfer config.
SLIDING_WINDOW = 1;
// The data source supports data auto refresh, and runs will be scheduled
// for the past few days. Allows custom values to be set for each transfer
// config.
CUSTOM_SLIDING_WINDOW = 2;
}
// Output only. Data source resource name.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Data source id.
string data_source_id = 2;
// User friendly data source name.
string display_name = 3;
// User friendly data source description string.
string description = 4;
// Data source client id which should be used to receive refresh token.
string client_id = 5;
// Api auth scopes for which refresh token needs to be obtained. These are
// scopes needed by a data source to prepare data and ingest them into
// BigQuery, e.g., https://www.googleapis.com/auth/bigquery
repeated string scopes = 6;
// Deprecated. This field has no effect.
TransferType transfer_type = 7 [deprecated = true];
// Deprecated. This field has no effect.
bool supports_multiple_transfers = 8 [deprecated = true];
// The number of seconds to wait for an update from the data source
// before the Data Transfer Service marks the transfer as FAILED.
int32 update_deadline_seconds = 9;
// Default data transfer schedule.
// Examples of valid schedules include:
// `1st,3rd monday of month 15:30`,
// `every wed,fri of jan,jun 13:15`, and
// `first sunday of quarter 00:00`.
string default_schedule = 10;
// Specifies whether the data source supports a user defined schedule, or
// operates on the default schedule.
// When set to `true`, user can override default schedule.
bool supports_custom_schedule = 11;
// Data source parameters.
repeated DataSourceParameter parameters = 12;
// Url for the help document for this data source.
string help_url = 13;
// Indicates the type of authorization.
AuthorizationType authorization_type = 14;
// Specifies whether the data source supports automatic data refresh for the
// past few days, and how it's supported.
// For some data sources, data might not be complete until a few days later,
// so it's useful to refresh data automatically.
DataRefreshType data_refresh_type = 15;
// Default data refresh window on days.
// Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
int32 default_data_refresh_window_days = 16;
// Disables backfilling and manual run scheduling
// for the data source.
bool manual_runs_disabled = 17;
// The minimum interval for scheduler to schedule runs.
google.protobuf.Duration minimum_schedule_interval = 18;
}
// A request to get data source info.
message GetDataSourceRequest {
// Required. The field will contain name of the resource requested, for
// example: `projects/{project_id}/dataSources/{data_source_id}` or
// `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigquerydatatransfer.googleapis.com/DataSource"
}
];
}
// Request to list supported data sources and their data transfer settings.
message ListDataSourcesRequest {
// Required. The BigQuery project id for which data sources should be
// returned. Must be in the form: `projects/{project_id}` or
// `projects/{project_id}/locations/{location_id}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "bigquerydatatransfer.googleapis.com/DataSource"
}
];
// Pagination token, which can be used to request a specific page
// of `ListDataSourcesRequest` list results. For multiple-page
// results, `ListDataSourcesResponse` outputs
// a `next_page` token, which can be used as the
// `page_token` value to request the next page of list results.
string page_token = 3;
// Page size. The default page size is the maximum value of 1000 results.
int32 page_size = 4;
}
// Returns list of supported data sources and their metadata.
message ListDataSourcesResponse {
// List of supported data sources and their transfer settings.
repeated DataSource data_sources = 1;
// Output only. The next-pagination token. For multiple-page list results,
// this token can be used as the
// `ListDataSourcesRequest.page_token`
// to request the next page of list results.
string next_page_token = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A request to create a data transfer configuration. If new credentials are
// needed for this transfer configuration, authorization info must be provided.
// If authorization info is provided, the transfer configuration will be
// associated with the user id corresponding to the authorization info.
// Otherwise, the transfer configuration will be associated with the calling
// user.
message CreateTransferConfigRequest {
// Required. The BigQuery project id where the transfer configuration should
// be created. Must be in the format
// projects/{project_id}/locations/{location_id} or projects/{project_id}. If
// specified location and location of the destination bigquery dataset do not
// match - the request will fail.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "bigquerydatatransfer.googleapis.com/TransferConfig"
}
];
// Required. Data transfer configuration to create.
TransferConfig transfer_config = 2 [(google.api.field_behavior) = REQUIRED];
// Optional OAuth2 authorization code to use with this transfer configuration.
// This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
// and new credentials are needed, as indicated by `CheckValidCreds`. In order
// to obtain authorization_code, make a request to the following URL:
// <pre class="prettyprint" suppresswarning="true">
// https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
// </pre>
// * The <var>client_id</var> is the OAuth client_id of the a data source as
// returned by ListDataSources method.
// * <var>data_source_scopes</var> are the scopes returned by ListDataSources
// method.
//
// Note that this should not be set when `service_account_name` is used to
// create the transfer config.
string authorization_code = 3;
// Optional version info. This is required only if
// `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
// are needed, as indicated by `CheckValidCreds`. In order to obtain version
// info, make a request to the following URL:
// <pre class="prettyprint" suppresswarning="true">
// https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
// </pre>
// * The <var>client_id</var> is the OAuth client_id of the a data source as
// returned by ListDataSources method.
// * <var>data_source_scopes</var> are the scopes returned by ListDataSources
// method.
//
// Note that this should not be set when `service_account_name` is used to
// create the transfer config.
string version_info = 5;
// Optional service account email. If this field is set, the transfer config
// will be created with this service account's credentials. It requires that
// the requesting user calling this API has permissions to act as this service
// account.
//
// Note that not all data sources support service account credentials when
// creating a transfer config. For the latest list of data sources, read about
// [using service
// accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
string service_account_name = 6;
}
// A request to update a transfer configuration. To update the user id of the
// transfer configuration, authorization info needs to be provided.
message UpdateTransferConfigRequest {
// Required. Data transfer configuration to create.
TransferConfig transfer_config = 1 [(google.api.field_behavior) = REQUIRED];
// Optional OAuth2 authorization code to use with this transfer configuration.
// This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
// and new credentials are needed, as indicated by `CheckValidCreds`. In order
// to obtain authorization_code, make a request to the following URL:
// <pre class="prettyprint" suppresswarning="true">
// https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
// </pre>
// * The <var>client_id</var> is the OAuth client_id of the a data source as
// returned by ListDataSources method.
// * <var>data_source_scopes</var> are the scopes returned by ListDataSources
// method.
//
// Note that this should not be set when `service_account_name` is used to
// update the transfer config.
string authorization_code = 3;
// Required. Required list of fields to be updated in this request.
google.protobuf.FieldMask update_mask = 4
[(google.api.field_behavior) = REQUIRED];
// Optional version info. This is required only if
// `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
// are needed, as indicated by `CheckValidCreds`. In order to obtain version
// info, make a request to the following URL:
// <pre class="prettyprint" suppresswarning="true">
// https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
// </pre>
// * The <var>client_id</var> is the OAuth client_id of the a data source as
// returned by ListDataSources method.
// * <var>data_source_scopes</var> are the scopes returned by ListDataSources
// method.
//
// Note that this should not be set when `service_account_name` is used to
// update the transfer config.
string version_info = 5;
// Optional service account email. If this field is set, the transfer config
// will be created with this service account's credentials. It requires that
// the requesting user calling this API has permissions to act as this service
// account.
//
// Note that not all data sources support service account credentials when
// creating a transfer config. For the latest list of data sources, read about
// [using service
// accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
string service_account_name = 6;
}
// A request to get data transfer information.
message GetTransferConfigRequest {
// Required. The field will contain name of the resource requested, for
// example: `projects/{project_id}/transferConfigs/{config_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigquerydatatransfer.googleapis.com/TransferConfig"
}
];
}
// A request to delete data transfer information. All associated transfer runs
// and log messages will be deleted as well.
message DeleteTransferConfigRequest {
// Required. The field will contain name of the resource requested, for
// example: `projects/{project_id}/transferConfigs/{config_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigquerydatatransfer.googleapis.com/TransferConfig"
}
];
}
// A request to get data transfer run information.
message GetTransferRunRequest {
// Required. The field will contain name of the resource requested, for
// example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
// or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigquerydatatransfer.googleapis.com/Run"
}
];
}
// A request to delete data transfer run information.
message DeleteTransferRunRequest {
// Required. The field will contain name of the resource requested, for
// example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
// or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigquerydatatransfer.googleapis.com/Run"
}
];
}
// A request to list data transfers configured for a BigQuery project.
message ListTransferConfigsRequest {
// Required. The BigQuery project id for which transfer configs
// should be returned: `projects/{project_id}` or
// `projects/{project_id}/locations/{location_id}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "bigquerydatatransfer.googleapis.com/TransferConfig"
}
];
// When specified, only configurations of requested data sources are returned.
repeated string data_source_ids = 2;
// Pagination token, which can be used to request a specific page
// of `ListTransfersRequest` list results. For multiple-page
// results, `ListTransfersResponse` outputs
// a `next_page` token, which can be used as the
// `page_token` value to request the next page of list results.
string page_token = 3;
// Page size. The default page size is the maximum value of 1000 results.
int32 page_size = 4;
}
// The returned list of pipelines in the project.
message ListTransferConfigsResponse {
// Output only. The stored pipeline transfer configurations.
repeated TransferConfig transfer_configs = 1
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The next-pagination token. For multiple-page list results,
// this token can be used as the
// `ListTransferConfigsRequest.page_token`
// to request the next page of list results.
string next_page_token = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A request to list data transfer runs.
message ListTransferRunsRequest {
// Represents which runs should be pulled.
enum RunAttempt {
// All runs should be returned.
RUN_ATTEMPT_UNSPECIFIED = 0;
// Only latest run per day should be returned.
LATEST = 1;
}
// Required. Name of transfer configuration for which transfer runs should be
// retrieved. Format of transfer configuration resource name is:
// `projects/{project_id}/transferConfigs/{config_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "bigquerydatatransfer.googleapis.com/Run"
}
];
// When specified, only transfer runs with requested states are returned.
repeated TransferState states = 2;
// Pagination token, which can be used to request a specific page
// of `ListTransferRunsRequest` list results. For multiple-page
// results, `ListTransferRunsResponse` outputs
// a `next_page` token, which can be used as the
// `page_token` value to request the next page of list results.
string page_token = 3;
// Page size. The default page size is the maximum value of 1000 results.
int32 page_size = 4;
// Indicates how run attempts are to be pulled.
RunAttempt run_attempt = 5;
}
// The returned list of pipelines in the project.
message ListTransferRunsResponse {
// Output only. The stored pipeline transfer runs.
repeated TransferRun transfer_runs = 1
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The next-pagination token. For multiple-page list results,
// this token can be used as the
// `ListTransferRunsRequest.page_token`
// to request the next page of list results.
string next_page_token = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A request to get user facing log messages associated with data transfer run.
message ListTransferLogsRequest {
// Required. Transfer run name in the form:
// `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigquerydatatransfer.googleapis.com/Run"
}
];
// Pagination token, which can be used to request a specific page
// of `ListTransferLogsRequest` list results. For multiple-page
// results, `ListTransferLogsResponse` outputs
// a `next_page` token, which can be used as the
// `page_token` value to request the next page of list results.
string page_token = 4;
// Page size. The default page size is the maximum value of 1000 results.
int32 page_size = 5;
// Message types to return. If not populated - INFO, WARNING and ERROR
// messages are returned.
repeated TransferMessage.MessageSeverity message_types = 6;
}
// The returned list transfer run messages.
message ListTransferLogsResponse {
// Output only. The stored pipeline transfer messages.
repeated TransferMessage transfer_messages = 1
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The next-pagination token. For multiple-page list results,
// this token can be used as the
// `GetTransferRunLogRequest.page_token`
// to request the next page of list results.
string next_page_token = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A request to determine whether the user has valid credentials. This method
// is used to limit the number of OAuth popups in the user interface. The
// user id is inferred from the API call context.
// If the data source has the Google+ authorization type, this method
// returns false, as it cannot be determined whether the credentials are
// already valid merely based on the user id.
message CheckValidCredsRequest {
// Required. The data source in the form:
// `projects/{project_id}/dataSources/{data_source_id}` or
// `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigquerydatatransfer.googleapis.com/DataSource"
}
];
}
// A response indicating whether the credentials exist and are valid.
message CheckValidCredsResponse {
// If set to `true`, the credentials exist and are valid.
bool has_valid_creds = 1;
}
// A request to schedule transfer runs for a time range.
message ScheduleTransferRunsRequest {
// Required. Transfer configuration name in the form:
// `projects/{project_id}/transferConfigs/{config_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigquerydatatransfer.googleapis.com/TransferConfig"
}
];
// Required. Start time of the range of transfer runs. For example,
// `"2017-05-25T00:00:00+00:00"`.
google.protobuf.Timestamp start_time = 2
[(google.api.field_behavior) = REQUIRED];
// Required. End time of the range of transfer runs. For example,
// `"2017-05-30T00:00:00+00:00"`.
google.protobuf.Timestamp end_time = 3
[(google.api.field_behavior) = REQUIRED];
}
// A response to schedule transfer runs for a time range.
message ScheduleTransferRunsResponse {
// The transfer runs that were scheduled.
repeated TransferRun runs = 1;
}
// A request to start manual transfer runs.
message StartManualTransferRunsRequest {
// A specification for a time range, this will request transfer runs with
// run_time between start_time (inclusive) and end_time (exclusive).
message TimeRange {
// Start time of the range of transfer runs. For example,
// `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than
// the end_time. Creates transfer runs where run_time is in the range
// between start_time (inclusive) and end_time (exclusive).
google.protobuf.Timestamp start_time = 1;
// End time of the range of transfer runs. For example,
// `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future.
// Creates transfer runs where run_time is in the range between start_time
// (inclusive) and end_time (exclusive).
google.protobuf.Timestamp end_time = 2;
}
// Transfer configuration name in the form:
// `projects/{project_id}/transferConfigs/{config_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
string parent = 1 [(google.api.resource_reference) = {
type: "bigquerydatatransfer.googleapis.com/TransferConfig"
}];
// The requested time specification - this can be a time range or a specific
// run_time.
oneof time {
// A time_range start and end timestamp for historical data files or reports
// that are scheduled to be transferred by the scheduled transfer run.
// requested_time_range must be a past time and cannot include future time
// values.
TimeRange requested_time_range = 3;
// A run_time timestamp for historical data files or reports
// that are scheduled to be transferred by the scheduled transfer run.
// requested_run_time must be a past time and cannot include future time
// values.
google.protobuf.Timestamp requested_run_time = 4;
}
}
// A response to start manual transfer runs.
message StartManualTransferRunsResponse {
// The transfer runs that were created.
repeated TransferRun runs = 1;
}
// A request to enroll a set of data sources so they are visible in the
// BigQuery UI's `Transfer` tab.
message EnrollDataSourcesRequest {
// The name of the project resource in the form: `projects/{project_id}`
string name = 1;
// Data sources that are enrolled. It is required to provide at least one
// data source id.
repeated string data_source_ids = 2;
}