google-cloud-bigquery-data_transfer-v1 0.4.0 → 0.4.4

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 46337ff5b7450e216fbff261edab3460d5b9e0b369c9de6618143ced3bc0d144
4
- data.tar.gz: cf645d7c13709bc829df88e282f4802d5364626b1dff52ad7b89ffdedb33f94b
3
+ metadata.gz: 58a018d821207c28605f8c2288b168ac51c496e676a0bd26036b51cb5aabb70e
4
+ data.tar.gz: b067a3dfdfa53209b06a1bfa0554a2755906de0f1e3be65204a09d4e85c58d21
5
5
  SHA512:
6
- metadata.gz: 792f2cf0062579a561c7937ddaeaf24b3f03031cd511104ae7ecdc60683012831dc7afb8d5bdf609dc8e2ba3ea95452d4b977f7d3b43fa5d04c819273bc8ffaf
7
- data.tar.gz: 7276674ccb0692b8e515fea47c6a1f6ee35d958b496c5ea89385188def06d6082c84fc7400c50d41e632d2a25bed2fb803c9c3b73000f74f6324d5611804ed35
6
+ metadata.gz: 67f666a9d4e67640172723fcf3c327224a84874483742f7ac77d625c0375524b3aeaac280febf86a3ab057f5ff1f954f4cacfdd1026388582671ca3a8ff10ea3
7
+ data.tar.gz: d91f2bae8a81c92abcb20ee095462709929bcb3ed05f51d6e497153d5fe110b69d260e33f38add6790d0698837a751f8b94e3b05d3d21ed1a594037c7da2770e
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-bigquery-data_transfer-v1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Credentials}):
68
68
 
69
- 1. `DATA_TRANSFER_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `DATA_TRANSFER_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
69
+ * `DATA_TRANSFER_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `DATA_TRANSFER_KEYFILE` - Path to JSON file, or JSON contents
71
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
+ * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
74
74
 
75
75
  ```ruby
76
76
  require "google/cloud/bigquery/data_transfer/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Clien
82
82
 
83
83
  ### Configuration
84
84
 
85
- The **Credentials JSON** can be configured instead of placing them in
86
- environment variables. Either on an individual client initialization:
85
+ The path to the **Credentials JSON** file can be configured instead of storing
86
+ it in an environment variable. Either on an individual client initialization:
87
87
 
88
88
  ```ruby
89
89
  require "google/cloud/bigquery/data_transfer/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Clien
93
93
  end
94
94
  ```
95
95
 
96
- Or configured globally for all clients:
96
+ Or globally for all clients:
97
97
 
98
98
  ```ruby
99
99
  require "google/cloud/bigquery/data_transfer/v1"
data/README.md CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/bigquery/data_transfer/v1"
34
34
 
35
35
  client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::Bigquery::DataTransfer::V1::GetDataSourceRequest.new # (request fields as keyword arguments...)
37
37
  response = client.get_data_source request
38
38
  ```
39
39
 
@@ -45,13 +45,12 @@ module Google
45
45
  # See {::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client::Configuration}
46
46
  # for a description of the configuration fields.
47
47
  #
48
- # ## Example
48
+ # @example
49
49
  #
50
- # To modify the configuration for all DataTransferService clients:
51
- #
52
- # ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.configure do |config|
53
- # config.timeout = 10.0
54
- # end
50
+ # # Modify the configuration for all DataTransferService clients
51
+ # ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.configure do |config|
52
+ # config.timeout = 10.0
53
+ # end
55
54
  #
56
55
  # @yield [config] Configure the Client client.
57
56
  # @yieldparam config [Client::Configuration]
@@ -71,18 +70,12 @@ module Google
71
70
 
72
71
  default_config.rpcs.get_data_source.timeout = 20.0
73
72
  default_config.rpcs.get_data_source.retry_policy = {
74
- initial_delay: 0.1,
75
- max_delay: 60.0,
76
- multiplier: 1.3,
77
- retry_codes: [14, 4]
73
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
78
74
  }
79
75
 
80
76
  default_config.rpcs.list_data_sources.timeout = 20.0
81
77
  default_config.rpcs.list_data_sources.retry_policy = {
82
- initial_delay: 0.1,
83
- max_delay: 60.0,
84
- multiplier: 1.3,
85
- retry_codes: [14, 4]
78
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
86
79
  }
87
80
 
88
81
  default_config.rpcs.create_transfer_config.timeout = 30.0
@@ -91,68 +84,44 @@ module Google
91
84
 
92
85
  default_config.rpcs.delete_transfer_config.timeout = 20.0
93
86
  default_config.rpcs.delete_transfer_config.retry_policy = {
94
- initial_delay: 0.1,
95
- max_delay: 60.0,
96
- multiplier: 1.3,
97
- retry_codes: [14, 4]
87
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
98
88
  }
99
89
 
100
90
  default_config.rpcs.get_transfer_config.timeout = 20.0
101
91
  default_config.rpcs.get_transfer_config.retry_policy = {
102
- initial_delay: 0.1,
103
- max_delay: 60.0,
104
- multiplier: 1.3,
105
- retry_codes: [14, 4]
92
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
106
93
  }
107
94
 
108
95
  default_config.rpcs.list_transfer_configs.timeout = 20.0
109
96
  default_config.rpcs.list_transfer_configs.retry_policy = {
110
- initial_delay: 0.1,
111
- max_delay: 60.0,
112
- multiplier: 1.3,
113
- retry_codes: [14, 4]
97
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
114
98
  }
115
99
 
116
100
  default_config.rpcs.schedule_transfer_runs.timeout = 30.0
117
101
 
118
102
  default_config.rpcs.get_transfer_run.timeout = 20.0
119
103
  default_config.rpcs.get_transfer_run.retry_policy = {
120
- initial_delay: 0.1,
121
- max_delay: 60.0,
122
- multiplier: 1.3,
123
- retry_codes: [14, 4]
104
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
124
105
  }
125
106
 
126
107
  default_config.rpcs.delete_transfer_run.timeout = 20.0
127
108
  default_config.rpcs.delete_transfer_run.retry_policy = {
128
- initial_delay: 0.1,
129
- max_delay: 60.0,
130
- multiplier: 1.3,
131
- retry_codes: [14, 4]
109
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
132
110
  }
133
111
 
134
112
  default_config.rpcs.list_transfer_runs.timeout = 20.0
135
113
  default_config.rpcs.list_transfer_runs.retry_policy = {
136
- initial_delay: 0.1,
137
- max_delay: 60.0,
138
- multiplier: 1.3,
139
- retry_codes: [14, 4]
114
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
140
115
  }
141
116
 
142
117
  default_config.rpcs.list_transfer_logs.timeout = 20.0
143
118
  default_config.rpcs.list_transfer_logs.retry_policy = {
144
- initial_delay: 0.1,
145
- max_delay: 60.0,
146
- multiplier: 1.3,
147
- retry_codes: [14, 4]
119
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
148
120
  }
149
121
 
150
122
  default_config.rpcs.check_valid_creds.timeout = 20.0
151
123
  default_config.rpcs.check_valid_creds.retry_policy = {
152
- initial_delay: 0.1,
153
- max_delay: 60.0,
154
- multiplier: 1.3,
155
- retry_codes: [14, 4]
124
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
156
125
  }
157
126
 
158
127
  default_config
@@ -184,19 +153,15 @@ module Google
184
153
  ##
185
154
  # Create a new DataTransferService client object.
186
155
  #
187
- # ## Examples
188
- #
189
- # To create a new DataTransferService client with the default
190
- # configuration:
191
- #
192
- # client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new
156
+ # @example
193
157
  #
194
- # To create a new DataTransferService client with a custom
195
- # configuration:
158
+ # # Create a client using the default configuration
159
+ # client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new
196
160
  #
197
- # client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new do |config|
198
- # config.timeout = 10.0
199
- # end
161
+ # # Create a client using a custom configuration
162
+ # client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new do |config|
163
+ # config.timeout = 10.0
164
+ # end
200
165
  #
201
166
  # @yield [config] Configure the DataTransferService client.
202
167
  # @yieldparam config [Client::Configuration]
@@ -216,14 +181,13 @@ module Google
216
181
 
217
182
  # Create credentials
218
183
  credentials = @config.credentials
219
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
184
+ # Use self-signed JWT if the endpoint is unchanged from default,
220
185
  # but only if the default endpoint does not have a region prefix.
221
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
222
- @config.endpoint == Client.configure.endpoint &&
186
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
223
187
  !@config.endpoint.split(".").first.include?("-")
224
188
  credentials ||= Credentials.default scope: @config.scope,
225
189
  enable_self_signed_jwt: enable_self_signed_jwt
226
- if credentials.is_a?(String) || credentials.is_a?(Hash)
190
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
227
191
  credentials = Credentials.new credentials, scope: @config.scope
228
192
  end
229
193
  @quota_project_id = @config.quota_project
@@ -298,7 +262,9 @@ module Google
298
262
  options.apply_defaults timeout: @config.rpcs.get_data_source.timeout,
299
263
  metadata: metadata,
300
264
  retry_policy: @config.rpcs.get_data_source.retry_policy
301
- options.apply_defaults metadata: @config.metadata,
265
+
266
+ options.apply_defaults timeout: @config.timeout,
267
+ metadata: @config.metadata,
302
268
  retry_policy: @config.retry_policy
303
269
 
304
270
  @data_transfer_service_stub.call_rpc :get_data_source, request, options: options do |response, operation|
@@ -375,7 +341,9 @@ module Google
375
341
  options.apply_defaults timeout: @config.rpcs.list_data_sources.timeout,
376
342
  metadata: metadata,
377
343
  retry_policy: @config.rpcs.list_data_sources.retry_policy
378
- options.apply_defaults metadata: @config.metadata,
344
+
345
+ options.apply_defaults timeout: @config.timeout,
346
+ metadata: @config.metadata,
379
347
  retry_policy: @config.retry_policy
380
348
 
381
349
  @data_transfer_service_stub.call_rpc :list_data_sources, request, options: options do |response, operation|
@@ -476,7 +444,9 @@ module Google
476
444
  options.apply_defaults timeout: @config.rpcs.create_transfer_config.timeout,
477
445
  metadata: metadata,
478
446
  retry_policy: @config.rpcs.create_transfer_config.retry_policy
479
- options.apply_defaults metadata: @config.metadata,
447
+
448
+ options.apply_defaults timeout: @config.timeout,
449
+ metadata: @config.metadata,
480
450
  retry_policy: @config.retry_policy
481
451
 
482
452
  @data_transfer_service_stub.call_rpc :create_transfer_config, request, options: options do |response, operation|
@@ -575,7 +545,9 @@ module Google
575
545
  options.apply_defaults timeout: @config.rpcs.update_transfer_config.timeout,
576
546
  metadata: metadata,
577
547
  retry_policy: @config.rpcs.update_transfer_config.retry_policy
578
- options.apply_defaults metadata: @config.metadata,
548
+
549
+ options.apply_defaults timeout: @config.timeout,
550
+ metadata: @config.metadata,
579
551
  retry_policy: @config.retry_policy
580
552
 
581
553
  @data_transfer_service_stub.call_rpc :update_transfer_config, request, options: options do |response, operation|
@@ -644,7 +616,9 @@ module Google
644
616
  options.apply_defaults timeout: @config.rpcs.delete_transfer_config.timeout,
645
617
  metadata: metadata,
646
618
  retry_policy: @config.rpcs.delete_transfer_config.retry_policy
647
- options.apply_defaults metadata: @config.metadata,
619
+
620
+ options.apply_defaults timeout: @config.timeout,
621
+ metadata: @config.metadata,
648
622
  retry_policy: @config.retry_policy
649
623
 
650
624
  @data_transfer_service_stub.call_rpc :delete_transfer_config, request, options: options do |response, operation|
@@ -712,7 +686,9 @@ module Google
712
686
  options.apply_defaults timeout: @config.rpcs.get_transfer_config.timeout,
713
687
  metadata: metadata,
714
688
  retry_policy: @config.rpcs.get_transfer_config.retry_policy
715
- options.apply_defaults metadata: @config.metadata,
689
+
690
+ options.apply_defaults timeout: @config.timeout,
691
+ metadata: @config.metadata,
716
692
  retry_policy: @config.retry_policy
717
693
 
718
694
  @data_transfer_service_stub.call_rpc :get_transfer_config, request, options: options do |response, operation|
@@ -724,7 +700,8 @@ module Google
724
700
  end
725
701
 
726
702
  ##
727
- # Returns information about all data transfers in the project.
703
+ # Returns information about all transfer configs owned by a project in the
704
+ # specified location.
728
705
  #
729
706
  # @overload list_transfer_configs(request, options = nil)
730
707
  # Pass arguments to `list_transfer_configs` via a request object, either of type
@@ -790,7 +767,9 @@ module Google
790
767
  options.apply_defaults timeout: @config.rpcs.list_transfer_configs.timeout,
791
768
  metadata: metadata,
792
769
  retry_policy: @config.rpcs.list_transfer_configs.retry_policy
793
- options.apply_defaults metadata: @config.metadata,
770
+
771
+ options.apply_defaults timeout: @config.timeout,
772
+ metadata: @config.metadata,
794
773
  retry_policy: @config.retry_policy
795
774
 
796
775
  @data_transfer_service_stub.call_rpc :list_transfer_configs, request, options: options do |response, operation|
@@ -809,6 +788,8 @@ module Google
809
788
  # Note that runs are created per UTC time in the time range.
810
789
  # DEPRECATED: use StartManualTransferRuns instead.
811
790
  #
791
+ # @deprecated This method is deprecated and may be removed in the next major version update.
792
+ #
812
793
  # @overload schedule_transfer_runs(request, options = nil)
813
794
  # Pass arguments to `schedule_transfer_runs` via a request object, either of type
814
795
  # {::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsRequest} or an equivalent Hash.
@@ -869,7 +850,9 @@ module Google
869
850
  options.apply_defaults timeout: @config.rpcs.schedule_transfer_runs.timeout,
870
851
  metadata: metadata,
871
852
  retry_policy: @config.rpcs.schedule_transfer_runs.retry_policy
872
- options.apply_defaults metadata: @config.metadata,
853
+
854
+ options.apply_defaults timeout: @config.timeout,
855
+ metadata: @config.metadata,
873
856
  retry_policy: @config.retry_policy
874
857
 
875
858
  @data_transfer_service_stub.call_rpc :schedule_transfer_runs, request, options: options do |response, operation|
@@ -945,7 +928,9 @@ module Google
945
928
  options.apply_defaults timeout: @config.rpcs.start_manual_transfer_runs.timeout,
946
929
  metadata: metadata,
947
930
  retry_policy: @config.rpcs.start_manual_transfer_runs.retry_policy
948
- options.apply_defaults metadata: @config.metadata,
931
+
932
+ options.apply_defaults timeout: @config.timeout,
933
+ metadata: @config.metadata,
949
934
  retry_policy: @config.retry_policy
950
935
 
951
936
  @data_transfer_service_stub.call_rpc :start_manual_transfer_runs, request, options: options do |response, operation|
@@ -1013,7 +998,9 @@ module Google
1013
998
  options.apply_defaults timeout: @config.rpcs.get_transfer_run.timeout,
1014
999
  metadata: metadata,
1015
1000
  retry_policy: @config.rpcs.get_transfer_run.retry_policy
1016
- options.apply_defaults metadata: @config.metadata,
1001
+
1002
+ options.apply_defaults timeout: @config.timeout,
1003
+ metadata: @config.metadata,
1017
1004
  retry_policy: @config.retry_policy
1018
1005
 
1019
1006
  @data_transfer_service_stub.call_rpc :get_transfer_run, request, options: options do |response, operation|
@@ -1081,7 +1068,9 @@ module Google
1081
1068
  options.apply_defaults timeout: @config.rpcs.delete_transfer_run.timeout,
1082
1069
  metadata: metadata,
1083
1070
  retry_policy: @config.rpcs.delete_transfer_run.retry_policy
1084
- options.apply_defaults metadata: @config.metadata,
1071
+
1072
+ options.apply_defaults timeout: @config.timeout,
1073
+ metadata: @config.metadata,
1085
1074
  retry_policy: @config.retry_policy
1086
1075
 
1087
1076
  @data_transfer_service_stub.call_rpc :delete_transfer_run, request, options: options do |response, operation|
@@ -1162,7 +1151,9 @@ module Google
1162
1151
  options.apply_defaults timeout: @config.rpcs.list_transfer_runs.timeout,
1163
1152
  metadata: metadata,
1164
1153
  retry_policy: @config.rpcs.list_transfer_runs.retry_policy
1165
- options.apply_defaults metadata: @config.metadata,
1154
+
1155
+ options.apply_defaults timeout: @config.timeout,
1156
+ metadata: @config.metadata,
1166
1157
  retry_policy: @config.retry_policy
1167
1158
 
1168
1159
  @data_transfer_service_stub.call_rpc :list_transfer_runs, request, options: options do |response, operation|
@@ -1242,7 +1233,9 @@ module Google
1242
1233
  options.apply_defaults timeout: @config.rpcs.list_transfer_logs.timeout,
1243
1234
  metadata: metadata,
1244
1235
  retry_policy: @config.rpcs.list_transfer_logs.retry_policy
1245
- options.apply_defaults metadata: @config.metadata,
1236
+
1237
+ options.apply_defaults timeout: @config.timeout,
1238
+ metadata: @config.metadata,
1246
1239
  retry_policy: @config.retry_policy
1247
1240
 
1248
1241
  @data_transfer_service_stub.call_rpc :list_transfer_logs, request, options: options do |response, operation|
@@ -1316,7 +1309,9 @@ module Google
1316
1309
  options.apply_defaults timeout: @config.rpcs.check_valid_creds.timeout,
1317
1310
  metadata: metadata,
1318
1311
  retry_policy: @config.rpcs.check_valid_creds.retry_policy
1319
- options.apply_defaults metadata: @config.metadata,
1312
+
1313
+ options.apply_defaults timeout: @config.timeout,
1314
+ metadata: @config.metadata,
1320
1315
  retry_policy: @config.retry_policy
1321
1316
 
1322
1317
  @data_transfer_service_stub.call_rpc :check_valid_creds, request, options: options do |response, operation|
@@ -1340,22 +1335,21 @@ module Google
1340
1335
  # Configuration can be applied globally to all clients, or to a single client
1341
1336
  # on construction.
1342
1337
  #
1343
- # # Examples
1344
- #
1345
- # To modify the global config, setting the timeout for get_data_source
1346
- # to 20 seconds, and all remaining timeouts to 10 seconds:
1347
- #
1348
- # ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.configure do |config|
1349
- # config.timeout = 10.0
1350
- # config.rpcs.get_data_source.timeout = 20.0
1351
- # end
1352
- #
1353
- # To apply the above configuration only to a new client:
1354
- #
1355
- # client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new do |config|
1356
- # config.timeout = 10.0
1357
- # config.rpcs.get_data_source.timeout = 20.0
1358
- # end
1338
+ # @example
1339
+ #
1340
+ # # Modify the global config, setting the timeout for
1341
+ # # get_data_source to 20 seconds,
1342
+ # # and all remaining timeouts to 10 seconds.
1343
+ # ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.configure do |config|
1344
+ # config.timeout = 10.0
1345
+ # config.rpcs.get_data_source.timeout = 20.0
1346
+ # end
1347
+ #
1348
+ # # Apply the above configuration only to a new client.
1349
+ # client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new do |config|
1350
+ # config.timeout = 10.0
1351
+ # config.rpcs.get_data_source.timeout = 20.0
1352
+ # end
1359
1353
  #
1360
1354
  # @!attribute [rw] endpoint
1361
1355
  # The hostname or hostname:port of the service endpoint.
@@ -22,7 +22,7 @@ module Google
22
22
  module Bigquery
23
23
  module DataTransfer
24
24
  module V1
25
- VERSION = "0.4.0"
25
+ VERSION = "0.4.4"
26
26
  end
27
27
  end
28
28
  end
@@ -53,7 +53,8 @@ module Google
53
53
  rpc :DeleteTransferConfig, ::Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferConfigRequest, ::Google::Protobuf::Empty
54
54
  # Returns information about a data transfer config.
55
55
  rpc :GetTransferConfig, ::Google::Cloud::Bigquery::DataTransfer::V1::GetTransferConfigRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
56
- # Returns information about all data transfers in the project.
56
+ # Returns information about all transfer configs owned by a project in the
57
+ # specified location.
57
58
  rpc :ListTransferConfigs, ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsResponse
58
59
  # Creates transfer runs for a time range [start_time, end_time].
59
60
  # For each date - or whatever granularity the data source supports - in the
@@ -5,6 +5,7 @@ require 'google/protobuf'
5
5
 
6
6
  require 'google/api/field_behavior_pb'
7
7
  require 'google/api/resource_pb'
8
+ require 'google/protobuf/duration_pb'
8
9
  require 'google/protobuf/struct_pb'
9
10
  require 'google/protobuf/timestamp_pb'
10
11
  require 'google/rpc/status_pb'
@@ -57,9 +57,15 @@ module Google
57
57
 
58
58
  # Denotes that a (repeated) field is an unordered list.
59
59
  # This indicates that the service may provide the elements of the list
60
- # in any arbitrary order, rather than the order the user originally
60
+ # in any arbitrary order, rather than the order the user originally
61
61
  # provided. Additionally, the list's order may or may not be stable.
62
62
  UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
63
69
  end
64
70
  end
65
71
  end
@@ -195,9 +195,7 @@ module Google
195
195
  # exchanged for a refresh token on the backend.
196
196
  GOOGLE_PLUS_AUTHORIZATION_CODE = 2
197
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.
198
+ # Use First Party OAuth.
201
199
  FIRST_PARTY_OAUTH = 3
202
200
  end
203
201
 
@@ -617,14 +615,14 @@ module Google
617
615
  # @return [::Google::Protobuf::Timestamp]
618
616
  # Start time of the range of transfer runs. For example,
619
617
  # `"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).
618
+ # the end_time. Creates transfer runs where run_time is in the range
619
+ # between start_time (inclusive) and end_time (exclusive).
622
620
  # @!attribute [rw] end_time
623
621
  # @return [::Google::Protobuf::Timestamp]
624
622
  # End time of the range of transfer runs. For example,
625
623
  # `"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).
624
+ # Creates transfer runs where run_time is in the range between start_time
625
+ # (inclusive) and end_time (exclusive).
628
626
  class TimeRange
629
627
  include ::Google::Protobuf::MessageExts
630
628
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -66,12 +66,11 @@ module Google
66
66
  # @!attribute [rw] name
67
67
  # @return [::String]
68
68
  # The resource name of the transfer config.
69
- # Transfer config names have the form of
69
+ # Transfer config names have the form
70
70
  # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
71
- # The name is automatically generated based on the config_id specified in
72
- # CreateTransferConfigRequest along with project_id and region. If config_id
73
- # is not provided, usually a uuid, even though it is not guaranteed or
74
- # required, will be generated for config_id.
71
+ # Where `config_id` is usually a uuid, even though it is not
72
+ # guaranteed or required. The name is ignored when creating a transfer
73
+ # config.
75
74
  # @!attribute [rw] destination_dataset_id
76
75
  # @return [::String]
77
76
  # The BigQuery target dataset id.
@@ -83,7 +82,10 @@ module Google
83
82
  # Data source id. Cannot be changed once data transfer is created.
84
83
  # @!attribute [rw] params
85
84
  # @return [::Google::Protobuf::Struct]
86
- # Data transfer specific parameters.
85
+ # Parameters specific to each data source. For more information see the
86
+ # bq tab in the 'Setting up a data transfer' section for each data source.
87
+ # For example the parameters for Cloud Storage transfers are listed here:
88
+ # https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
87
89
  # @!attribute [rw] schedule
88
90
  # @return [::String]
89
91
  # Data transfer schedule.
@@ -132,6 +134,9 @@ module Google
132
134
  # @return [::String]
133
135
  # Pub/Sub topic where notifications will be sent after transfer runs
134
136
  # associated with this transfer config finish.
137
+ #
138
+ # The format for specifying a pubsub topic is:
139
+ # `projects/{project}/topics/{topic}`
135
140
  # @!attribute [rw] email_preferences
136
141
  # @return [::Google::Cloud::Bigquery::DataTransfer::V1::EmailPreferences]
137
142
  # Email notifications will be sent according to these preferences
@@ -171,7 +176,10 @@ module Google
171
176
  # Output only. Last time the data transfer run state was updated.
172
177
  # @!attribute [r] params
173
178
  # @return [::Google::Protobuf::Struct]
174
- # Output only. Data transfer specific parameters.
179
+ # Output only. Parameters specific to each data source. For more information see the
180
+ # bq tab in the 'Setting up a data transfer' section for each data source.
181
+ # For example the parameters for Cloud Storage transfers are listed here:
182
+ # https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
175
183
  # @!attribute [r] destination_dataset_id
176
184
  # @return [::String]
177
185
  # Output only. The BigQuery target dataset id.
@@ -194,7 +202,10 @@ module Google
194
202
  # @!attribute [r] notification_pubsub_topic
195
203
  # @return [::String]
196
204
  # Output only. Pub/Sub topic where a notification will be sent after this
197
- # transfer run finishes
205
+ # transfer run finishes.
206
+ #
207
+ # The format for specifying a pubsub topic is:
208
+ # `projects/{project}/topics/{topic}`
198
209
  # @!attribute [r] email_preferences
199
210
  # @return [::Google::Cloud::Bigquery::DataTransfer::V1::EmailPreferences]
200
211
  # Output only. Email notifications will be sent according to these
@@ -250,23 +261,23 @@ module Google
250
261
 
251
262
  # Represents data transfer run state.
252
263
  module TransferState
253
- # State placeholder.
264
+ # State placeholder (0).
254
265
  TRANSFER_STATE_UNSPECIFIED = 0
255
266
 
256
267
  # Data transfer is scheduled and is waiting to be picked up by
257
- # data transfer backend.
268
+ # data transfer backend (2).
258
269
  PENDING = 2
259
270
 
260
- # Data transfer is in progress.
271
+ # Data transfer is in progress (3).
261
272
  RUNNING = 3
262
273
 
263
- # Data transfer completed successfully.
274
+ # Data transfer completed successfully (4).
264
275
  SUCCEEDED = 4
265
276
 
266
- # Data transfer failed.
277
+ # Data transfer failed (5).
267
278
  FAILED = 5
268
279
 
269
- # Data transfer is cancelled.
280
+ # Data transfer is cancelled (6).
270
281
  CANCELLED = 6
271
282
  end
272
283
  end
metadata CHANGED
@@ -1,29 +1,35 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-bigquery-data_transfer-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.4.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-09 00:00:00.000000000 Z
11
+ date: 2021-08-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0.7'
20
+ - - "<"
18
21
  - !ruby/object:Gem::Version
19
- version: '0.3'
22
+ version: 2.a
20
23
  type: :runtime
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
- - - "~>"
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ version: '0.7'
30
+ - - "<"
25
31
  - !ruby/object:Gem::Version
26
- version: '0.3'
32
+ version: 2.a
27
33
  - !ruby/object:Gem::Dependency
28
34
  name: google-cloud-errors
29
35
  requirement: !ruby/object:Gem::Requirement
@@ -206,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
206
212
  - !ruby/object:Gem::Version
207
213
  version: '0'
208
214
  requirements: []
209
- rubygems_version: 3.2.13
215
+ rubygems_version: 3.2.17
210
216
  signing_key:
211
217
  specification_version: 4
212
218
  summary: API Client library for the BigQuery Data Transfer Service V1 API