google-cloud-bigquery-data_transfer-v1 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (21) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +6 -6
  3. data/README.md +1 -1
  4. data/lib/google/cloud/bigquery/data_transfer/v1.rb +1 -1
  5. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service.rb +1 -1
  6. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb +288 -288
  7. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/credentials.rb +1 -1
  8. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/paths.rb +20 -20
  9. data/lib/google/cloud/bigquery/data_transfer/v1/version.rb +1 -1
  10. data/proto_docs/google/api/resource.rb +12 -12
  11. data/proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb +133 -133
  12. data/proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb +48 -48
  13. data/proto_docs/google/protobuf/any.rb +4 -4
  14. data/proto_docs/google/protobuf/duration.rb +4 -4
  15. data/proto_docs/google/protobuf/empty.rb +2 -2
  16. data/proto_docs/google/protobuf/field_mask.rb +3 -3
  17. data/proto_docs/google/protobuf/struct.rb +18 -18
  18. data/proto_docs/google/protobuf/timestamp.rb +4 -4
  19. data/proto_docs/google/protobuf/wrappers.rb +27 -27
  20. data/proto_docs/google/rpc/status.rb +6 -6
  21. metadata +2 -2
data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/credentials.rb CHANGED
@@ -25,7 +25,7 @@ module Google
25
25
  module V1
26
26
  module DataTransferService
27
27
  # Credentials for the DataTransferService API.
28
- class Credentials < Google::Auth::Credentials
28
+ class Credentials < ::Google::Auth::Credentials
29
29
  self.scope = [
30
30
  "https://www.googleapis.com/auth/cloud-platform"
31
31
  ]
data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/paths.rb CHANGED
@@ -45,24 +45,24 @@ module Google
45
45
  # @param location [String]
46
46
  # @param data_source [String]
47
47
  #
48
- # @return [String]
48
+ # @return [::String]
49
49
  def data_source_path **args
50
50
  resources = {
51
51
  "data_source:project" => (proc do |project:, data_source:|
52
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
52
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
53
53
 
54
54
  "projects/#{project}/dataSources/#{data_source}"
55
55
  end),
56
56
  "data_source:location:project" => (proc do |project:, location:, data_source:|
57
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
58
- raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
57
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
58
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
59
59
 
60
60
  "projects/#{project}/locations/#{location}/dataSources/#{data_source}"
61
61
  end)
62
62
  }
63
63
 
64
64
  resource = resources[args.keys.sort.join(":")]
65
- raise ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
65
+ raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
66
66
  resource.call(**args)
67
67
  end
68
68
 
@@ -76,9 +76,9 @@ module Google
76
76
  # @param project [String]
77
77
  # @param location [String]
78
78
  #
79
- # @return [String]
79
+ # @return [::String]
80
80
  def location_path project:, location:
81
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
81
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
82
82
 
83
83
  "projects/#{project}/locations/#{location}"
84
84
  end
@@ -92,7 +92,7 @@ module Google
92
92
  #
93
93
  # @param project [String]
94
94
  #
95
- # @return [String]
95
+ # @return [::String]
96
96
  def project_path project:
97
97
  "projects/#{project}"
98
98
  end
@@ -119,26 +119,26 @@ module Google
119
119
  # @param transfer_config [String]
120
120
  # @param run [String]
121
121
  #
122
- # @return [String]
122
+ # @return [::String]
123
123
  def run_path **args
124
124
  resources = {
125
125
  "project:run:transfer_config" => (proc do |project:, transfer_config:, run:|
126
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
127
- raise ArgumentError, "transfer_config cannot contain /" if transfer_config.to_s.include? "/"
126
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
127
+ raise ::ArgumentError, "transfer_config cannot contain /" if transfer_config.to_s.include? "/"
128
128
 
129
129
  "projects/#{project}/transferConfigs/#{transfer_config}/runs/#{run}"
130
130
  end),
131
131
  "location:project:run:transfer_config" => (proc do |project:, location:, transfer_config:, run:|
132
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
133
- raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
134
- raise ArgumentError, "transfer_config cannot contain /" if transfer_config.to_s.include? "/"
132
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
133
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
134
+ raise ::ArgumentError, "transfer_config cannot contain /" if transfer_config.to_s.include? "/"
135
135
 
136
136
  "projects/#{project}/locations/#{location}/transferConfigs/#{transfer_config}/runs/#{run}"
137
137
  end)
138
138
  }
139
139
 
140
140
  resource = resources[args.keys.sort.join(":")]
141
- raise ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
141
+ raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
142
142
  resource.call(**args)
143
143
  end
144
144
 
@@ -162,24 +162,24 @@ module Google
162
162
  # @param location [String]
163
163
  # @param transfer_config [String]
164
164
  #
165
- # @return [String]
165
+ # @return [::String]
166
166
  def transfer_config_path **args
167
167
  resources = {
168
168
  "project:transfer_config" => (proc do |project:, transfer_config:|
169
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
169
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
170
170
 
171
171
  "projects/#{project}/transferConfigs/#{transfer_config}"
172
172
  end),
173
173
  "location:project:transfer_config" => (proc do |project:, location:, transfer_config:|
174
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
175
- raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
174
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
175
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
176
176
 
177
177
  "projects/#{project}/locations/#{location}/transferConfigs/#{transfer_config}"
178
178
  end)
179
179
  }
180
180
 
181
181
  resource = resources[args.keys.sort.join(":")]
182
- raise ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
182
+ raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
183
183
  resource.call(**args)
184
184
  end
185
185
 
data/lib/google/cloud/bigquery/data_transfer/v1/version.rb CHANGED
@@ -22,7 +22,7 @@ module Google
22
22
  module Bigquery
23
23
  module DataTransfer
24
24
  module V1
25
- VERSION = "0.1.0"
25
+ VERSION = "0.1.1"
26
26
  end
27
27
  end
28
28
  end
data/proto_docs/google/api/resource.rb CHANGED
@@ -128,7 +128,7 @@ module Google
128
128
  # - pattern: "shelves/{shelf}"
129
129
  # parent_type: "cloudresourcemanager.googleapis.com/Folder"
130
130
  # @!attribute [rw] type
131
- # @return [String]
131
+ # @return [::String]
132
132
  # The resource type. It must be in the format of
133
133
  # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
134
134
  # singular and must not include version numbers.
@@ -140,7 +140,7 @@ module Google
140
140
  # should use PascalCase (UpperCamelCase). The maximum number of
141
141
  # characters allowed for the `resource_type_kind` is 100.
142
142
  # @!attribute [rw] pattern
143
- # @return [Array<String>]
143
+ # @return [::Array<::String>]
144
144
  # Optional. The relative resource name pattern associated with this resource
145
145
  # type. The DNS prefix of the full resource name shouldn't be specified here.
146
146
  #
@@ -161,11 +161,11 @@ module Google
161
161
  # the same component name (e.g. "project") refers to IDs of the same
162
162
  # type of resource.
163
163
  # @!attribute [rw] name_field
164
- # @return [String]
164
+ # @return [::String]
165
165
  # Optional. The field on the resource that designates the resource name
166
166
  # field. If omitted, this is assumed to be "name".
167
167
  # @!attribute [rw] history
168
- # @return [Google::Api::ResourceDescriptor::History]
168
+ # @return [::Google::Api::ResourceDescriptor::History]
169
169
  # Optional. The historical or future-looking state of the resource pattern.
170
170
  #
171
171
  # Example:
@@ -182,19 +182,19 @@ module Google
182
182
  # };
183
183
  # }
184
184
  # @!attribute [rw] plural
185
- # @return [String]
185
+ # @return [::String]
186
186
  # The plural name used in the resource name, such as 'projects' for
187
187
  # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
188
  # field in k8s CRD spec
189
189
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
190
190
  # @!attribute [rw] singular
191
- # @return [String]
191
+ # @return [::String]
192
192
  # The same concept of the `singular` field in k8s CRD spec
193
193
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
194
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
195
195
  class ResourceDescriptor
196
- include Google::Protobuf::MessageExts
197
- extend Google::Protobuf::MessageExts::ClassMethods
196
+ include ::Google::Protobuf::MessageExts
197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
198
198
 
199
199
  # A description of the historical or future-looking state of the
200
200
  # resource pattern.
@@ -216,7 +216,7 @@ module Google
216
216
  # Defines a proto annotation that describes a string field that refers to
217
217
  # an API resource.
218
218
  # @!attribute [rw] type
219
- # @return [String]
219
+ # @return [::String]
220
220
  # The resource type that the annotated field references.
221
221
  #
222
222
  # Example:
@@ -227,7 +227,7 @@ module Google
227
227
  # }];
228
228
  # }
229
229
  # @!attribute [rw] child_type
230
- # @return [String]
230
+ # @return [::String]
231
231
  # The resource type of a child collection that the annotated field
232
232
  # references. This is useful for annotating the `parent` field that
233
233
  # doesn't have a fixed resource type.
@@ -240,8 +240,8 @@ module Google
240
240
  # };
241
241
  # }
242
242
  class ResourceReference
243
- include Google::Protobuf::MessageExts
244
- extend Google::Protobuf::MessageExts::ClassMethods
243
+ include ::Google::Protobuf::MessageExts
244
+ extend ::Google::Protobuf::MessageExts::ClassMethods
245
245
  end
246
246
  end
247
247
  end
data/proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb CHANGED
@@ -29,58 +29,58 @@ module Google
29
29
  # Thus, whoever uses this api can decide to generate either generic ui,
30
30
  # or custom data source specific forms.
31
31
  # @!attribute [rw] param_id
32
- # @return [String]
32
+ # @return [::String]
33
33
  # Parameter identifier.
34
34
  # @!attribute [rw] display_name
35
- # @return [String]
35
+ # @return [::String]
36
36
  # Parameter display name in the user interface.
37
37
  # @!attribute [rw] description
38
- # @return [String]
38
+ # @return [::String]
39
39
  # Parameter description.
40
40
  # @!attribute [rw] type
41
- # @return [Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter::Type]
41
+ # @return [::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter::Type]
42
42
  # Parameter type.
43
43
  # @!attribute [rw] required
44
- # @return [Boolean]
44
+ # @return [::Boolean]
45
45
  # Is parameter required.
46
46
  # @!attribute [rw] repeated
47
- # @return [Boolean]
47
+ # @return [::Boolean]
48
48
  # Deprecated. This field has no effect.
49
49
  # @!attribute [rw] validation_regex
50
- # @return [String]
50
+ # @return [::String]
51
51
  # Regular expression which can be used for parameter validation.
52
52
  # @!attribute [rw] allowed_values
53
- # @return [Array<String>]
53
+ # @return [::Array<::String>]
54
54
  # All possible values for the parameter.
55
55
  # @!attribute [rw] min_value
56
- # @return [Google::Protobuf::DoubleValue]
56
+ # @return [::Google::Protobuf::DoubleValue]
57
57
  # For integer and double values specifies minimum allowed value.
58
58
  # @!attribute [rw] max_value
59
- # @return [Google::Protobuf::DoubleValue]
59
+ # @return [::Google::Protobuf::DoubleValue]
60
60
  # For integer and double values specifies maxminum allowed value.
61
61
  # @!attribute [rw] fields
62
- # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>]
62
+ # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>]
63
63
  # Deprecated. This field has no effect.
64
64
  # @!attribute [rw] validation_description
65
- # @return [String]
65
+ # @return [::String]
66
66
  # Description of the requirements for this field, in case the user input does
67
67
  # not fulfill the regex pattern or min/max values.
68
68
  # @!attribute [rw] validation_help_url
69
- # @return [String]
69
+ # @return [::String]
70
70
  # URL to a help document to further explain the naming requirements.
71
71
  # @!attribute [rw] immutable
72
- # @return [Boolean]
72
+ # @return [::Boolean]
73
73
  # Cannot be changed after initial creation.
74
74
  # @!attribute [rw] recurse
75
- # @return [Boolean]
75
+ # @return [::Boolean]
76
76
  # Deprecated. This field has no effect.
77
77
  # @!attribute [rw] deprecated
78
- # @return [Boolean]
78
+ # @return [::Boolean]
79
79
  # If true, it should not be used in new transfers, and it should not be
80
80
  # visible to users.
81
81
  class DataSourceParameter
82
- include Google::Protobuf::MessageExts
83
- extend Google::Protobuf::MessageExts::ClassMethods
82
+ include ::Google::Protobuf::MessageExts
83
+ extend ::Google::Protobuf::MessageExts::ClassMethods
84
84
 
85
85
  # Parameter type.
86
86
  module Type
@@ -111,76 +111,76 @@ module Google
111
111
  # Represents data source metadata. Metadata is sufficient to
112
112
  # render UI and request proper OAuth tokens.
113
113
  # @!attribute [r] name
114
- # @return [String]
114
+ # @return [::String]
115
115
  # Output only. Data source resource name.
116
116
  # @!attribute [rw] data_source_id
117
- # @return [String]
117
+ # @return [::String]
118
118
  # Data source id.
119
119
  # @!attribute [rw] display_name
120
- # @return [String]
120
+ # @return [::String]
121
121
  # User friendly data source name.
122
122
  # @!attribute [rw] description
123
- # @return [String]
123
+ # @return [::String]
124
124
  # User friendly data source description string.
125
125
  # @!attribute [rw] client_id
126
- # @return [String]
126
+ # @return [::String]
127
127
  # Data source client id which should be used to receive refresh token.
128
128
  # @!attribute [rw] scopes
129
- # @return [Array<String>]
129
+ # @return [::Array<::String>]
130
130
  # Api auth scopes for which refresh token needs to be obtained. These are
131
131
  # scopes needed by a data source to prepare data and ingest them into
132
132
  # BigQuery, e.g., https://www.googleapis.com/auth/bigquery
133
133
  # @!attribute [rw] transfer_type
134
- # @return [Google::Cloud::Bigquery::DataTransfer::V1::TransferType]
134
+ # @return [::Google::Cloud::Bigquery::DataTransfer::V1::TransferType]
135
135
  # Deprecated. This field has no effect.
136
136
  # @!attribute [rw] supports_multiple_transfers
137
- # @return [Boolean]
137
+ # @return [::Boolean]
138
138
  # Deprecated. This field has no effect.
139
139
  # @!attribute [rw] update_deadline_seconds
140
- # @return [Integer]
140
+ # @return [::Integer]
141
141
  # The number of seconds to wait for an update from the data source
142
142
  # before the Data Transfer Service marks the transfer as FAILED.
143
143
  # @!attribute [rw] default_schedule
144
- # @return [String]
144
+ # @return [::String]
145
145
  # Default data transfer schedule.
146
146
  # Examples of valid schedules include:
147
147
  # `1st,3rd monday of month 15:30`,
148
148
  # `every wed,fri of jan,jun 13:15`, and
149
149
  # `first sunday of quarter 00:00`.
150
150
  # @!attribute [rw] supports_custom_schedule
151
- # @return [Boolean]
151
+ # @return [::Boolean]
152
152
  # Specifies whether the data source supports a user defined schedule, or
153
153
  # operates on the default schedule.
154
154
  # When set to `true`, user can override default schedule.
155
155
  # @!attribute [rw] parameters
156
- # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>]
156
+ # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>]
157
157
  # Data source parameters.
158
158
  # @!attribute [rw] help_url
159
- # @return [String]
159
+ # @return [::String]
160
160
  # Url for the help document for this data source.
161
161
  # @!attribute [rw] authorization_type
162
- # @return [Google::Cloud::Bigquery::DataTransfer::V1::DataSource::AuthorizationType]
162
+ # @return [::Google::Cloud::Bigquery::DataTransfer::V1::DataSource::AuthorizationType]
163
163
  # Indicates the type of authorization.
164
164
  # @!attribute [rw] data_refresh_type
165
- # @return [Google::Cloud::Bigquery::DataTransfer::V1::DataSource::DataRefreshType]
165
+ # @return [::Google::Cloud::Bigquery::DataTransfer::V1::DataSource::DataRefreshType]
166
166
  # Specifies whether the data source supports automatic data refresh for the
167
167
  # past few days, and how it's supported.
168
168
  # For some data sources, data might not be complete until a few days later,
169
169
  # so it's useful to refresh data automatically.
170
170
  # @!attribute [rw] default_data_refresh_window_days
171
- # @return [Integer]
171
+ # @return [::Integer]
172
172
  # Default data refresh window on days.
173
173
  # Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
174
174
  # @!attribute [rw] manual_runs_disabled
175
- # @return [Boolean]
175
+ # @return [::Boolean]
176
176
  # Disables backfilling and manual run scheduling
177
177
  # for the data source.
178
178
  # @!attribute [rw] minimum_schedule_interval
179
- # @return [Google::Protobuf::Duration]
179
+ # @return [::Google::Protobuf::Duration]
180
180
  # The minimum interval for scheduler to schedule runs.
181
181
  class DataSource
182
- include Google::Protobuf::MessageExts
183
- extend Google::Protobuf::MessageExts::ClassMethods
182
+ include ::Google::Protobuf::MessageExts
183
+ extend ::Google::Protobuf::MessageExts::ClassMethods
184
184
 
185
185
  # The type of authorization needed for this data source.
186
186
  module AuthorizationType
@@ -220,49 +220,49 @@ module Google
220
220
 
221
221
  # A request to get data source info.
222
222
  # @!attribute [rw] name
223
- # @return [String]
223
+ # @return [::String]
224
224
  # Required. The field will contain name of the resource requested, for example:
225
225
  # `projects/{project_id}/dataSources/{data_source_id}` or
226
226
  # `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
227
227
  class GetDataSourceRequest
228
- include Google::Protobuf::MessageExts
229
- extend Google::Protobuf::MessageExts::ClassMethods
228
+ include ::Google::Protobuf::MessageExts
229
+ extend ::Google::Protobuf::MessageExts::ClassMethods
230
230
  end
231
231
 
232
232
  # Request to list supported data sources and their data transfer settings.
233
233
  # @!attribute [rw] parent
234
- # @return [String]
234
+ # @return [::String]
235
235
  # Required. The BigQuery project id for which data sources should be returned.
236
236
  # Must be in the form: `projects/{project_id}` or
237
237
  # `projects/{project_id}/locations/{location_id}
238
238
  # @!attribute [rw] page_token
239
- # @return [String]
239
+ # @return [::String]
240
240
  # Pagination token, which can be used to request a specific page
241
241
  # of `ListDataSourcesRequest` list results. For multiple-page
242
242
  # results, `ListDataSourcesResponse` outputs
243
243
  # a `next_page` token, which can be used as the
244
244
  # `page_token` value to request the next page of list results.
245
245
  # @!attribute [rw] page_size
246
- # @return [Integer]
246
+ # @return [::Integer]
247
247
  # Page size. The default page size is the maximum value of 1000 results.
248
248
  class ListDataSourcesRequest
249
- include Google::Protobuf::MessageExts
250
- extend Google::Protobuf::MessageExts::ClassMethods
249
+ include ::Google::Protobuf::MessageExts
250
+ extend ::Google::Protobuf::MessageExts::ClassMethods
251
251
  end
252
252
 
253
253
  # Returns list of supported data sources and their metadata.
254
254
  # @!attribute [rw] data_sources
255
- # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::DataSource>]
255
+ # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSource>]
256
256
  # List of supported data sources and their transfer settings.
257
257
  # @!attribute [r] next_page_token
258
- # @return [String]
258
+ # @return [::String]
259
259
  # Output only. The next-pagination token. For multiple-page list results,
260
260
  # this token can be used as the
261
261
  # `ListDataSourcesRequest.page_token`
262
262
  # to request the next page of list results.
263
263
  class ListDataSourcesResponse
264
- include Google::Protobuf::MessageExts
265
- extend Google::Protobuf::MessageExts::ClassMethods
264
+ include ::Google::Protobuf::MessageExts
265
+ extend ::Google::Protobuf::MessageExts::ClassMethods
266
266
  end
267
267
 
268
268
  # A request to create a data transfer configuration. If new credentials are
@@ -272,16 +272,16 @@ module Google
272
272
  # authorization code. Otherwise, the transfer configuration will be associated
273
273
  # with the calling user.
274
274
  # @!attribute [rw] parent
275
- # @return [String]
275
+ # @return [::String]
276
276
  # Required. The BigQuery project id where the transfer configuration should be created.
277
277
  # Must be in the format projects/\\{project_id}/locations/\\{location_id} or
278
278
  # projects/\\{project_id}. If specified location and location of the
279
279
  # destination bigquery dataset do not match - the request will fail.
280
280
  # @!attribute [rw] transfer_config
281
- # @return [Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
281
+ # @return [::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
282
282
  # Required. Data transfer configuration to create.
283
283
  # @!attribute [rw] authorization_code
284
- # @return [String]
284
+ # @return [::String]
285
285
  # Optional OAuth2 authorization code to use with this transfer configuration.
286
286
  # This is required if new credentials are needed, as indicated by
287
287
  # `CheckValidCreds`.
@@ -299,7 +299,7 @@ module Google
299
299
  # returned in the title bar of the browser, with the page text prompting
300
300
  # the user to copy the code and paste it in the application.
301
301
  # @!attribute [rw] version_info
302
- # @return [String]
302
+ # @return [::String]
303
303
  # Optional version info. If users want to find a very recent access token,
304
304
  # that is, immediately after approving access, users have to set the
305
305
  # version_info claim in the token request. To obtain the version_info, users
@@ -307,23 +307,23 @@ module Google
307
307
  # version_info back in the authorization response which be be put in a JWT
308
308
  # claim in the token request.
309
309
  # @!attribute [rw] service_account_name
310
- # @return [String]
310
+ # @return [::String]
311
311
  # Optional service account name. If this field is set, transfer config will
312
312
  # be created with this service account credentials. It requires that
313
313
  # requesting user calling this API has permissions to act as this service
314
314
  # account.
315
315
  class CreateTransferConfigRequest
316
- include Google::Protobuf::MessageExts
317
- extend Google::Protobuf::MessageExts::ClassMethods
316
+ include ::Google::Protobuf::MessageExts
317
+ extend ::Google::Protobuf::MessageExts::ClassMethods
318
318
  end
319
319
 
320
320
  # A request to update a transfer configuration. To update the user id of the
321
321
  # transfer configuration, an authorization code needs to be provided.
322
322
  # @!attribute [rw] transfer_config
323
- # @return [Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
323
+ # @return [::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
324
324
  # Required. Data transfer configuration to create.
325
325
  # @!attribute [rw] authorization_code
326
- # @return [String]
326
+ # @return [::String]
327
327
  # Optional OAuth2 authorization code to use with this transfer configuration.
328
328
  # If it is provided, the transfer configuration will be associated with the
329
329
  # authorizing user.
@@ -341,10 +341,10 @@ module Google
341
341
  # returned in the title bar of the browser, with the page text prompting
342
342
  # the user to copy the code and paste it in the application.
343
343
  # @!attribute [rw] update_mask
344
- # @return [Google::Protobuf::FieldMask]
344
+ # @return [::Google::Protobuf::FieldMask]
345
345
  # Required. Required list of fields to be updated in this request.
346
346
  # @!attribute [rw] version_info
347
- # @return [String]
347
+ # @return [::String]
348
348
  # Optional version info. If users want to find a very recent access token,
349
349
  # that is, immediately after approving access, users have to set the
350
350
  # version_info claim in the token request. To obtain the version_info, users
@@ -352,129 +352,129 @@ module Google
352
352
  # version_info back in the authorization response which be be put in a JWT
353
353
  # claim in the token request.
354
354
  # @!attribute [rw] service_account_name
355
- # @return [String]
355
+ # @return [::String]
356
356
  # Optional service account name. If this field is set and
357
357
  # "service_account_name" is set in update_mask, transfer config will be
358
358
  # updated to use this service account credentials. It requires that
359
359
  # requesting user calling this API has permissions to act as this service
360
360
  # account.
361
361
  class UpdateTransferConfigRequest
362
- include Google::Protobuf::MessageExts
363
- extend Google::Protobuf::MessageExts::ClassMethods
362
+ include ::Google::Protobuf::MessageExts
363
+ extend ::Google::Protobuf::MessageExts::ClassMethods
364
364
  end
365
365
 
366
366
  # A request to get data transfer information.
367
367
  # @!attribute [rw] name
368
- # @return [String]
368
+ # @return [::String]
369
369
  # Required. The field will contain name of the resource requested, for example:
370
370
  # `projects/{project_id}/transferConfigs/{config_id}` or
371
371
  # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
372
372
  class GetTransferConfigRequest
373
- include Google::Protobuf::MessageExts
374
- extend Google::Protobuf::MessageExts::ClassMethods
373
+ include ::Google::Protobuf::MessageExts
374
+ extend ::Google::Protobuf::MessageExts::ClassMethods
375
375
  end
376
376
 
377
377
  # A request to delete data transfer information. All associated transfer runs
378
378
  # and log messages will be deleted as well.
379
379
  # @!attribute [rw] name
380
- # @return [String]
380
+ # @return [::String]
381
381
  # Required. The field will contain name of the resource requested, for example:
382
382
  # `projects/{project_id}/transferConfigs/{config_id}` or
383
383
  # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
384
384
  class DeleteTransferConfigRequest
385
- include Google::Protobuf::MessageExts
386
- extend Google::Protobuf::MessageExts::ClassMethods
385
+ include ::Google::Protobuf::MessageExts
386
+ extend ::Google::Protobuf::MessageExts::ClassMethods
387
387
  end
388
388
 
389
389
  # A request to get data transfer run information.
390
390
  # @!attribute [rw] name
391
- # @return [String]
391
+ # @return [::String]
392
392
  # Required. The field will contain name of the resource requested, for example:
393
393
  # `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
394
394
  # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
395
395
  class GetTransferRunRequest
396
- include Google::Protobuf::MessageExts
397
- extend Google::Protobuf::MessageExts::ClassMethods
396
+ include ::Google::Protobuf::MessageExts
397
+ extend ::Google::Protobuf::MessageExts::ClassMethods
398
398
  end
399
399
 
400
400
  # A request to delete data transfer run information.
401
401
  # @!attribute [rw] name
402
- # @return [String]
402
+ # @return [::String]
403
403
  # Required. The field will contain name of the resource requested, for example:
404
404
  # `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
405
405
  # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
406
406
  class DeleteTransferRunRequest
407
- include Google::Protobuf::MessageExts
408
- extend Google::Protobuf::MessageExts::ClassMethods
407
+ include ::Google::Protobuf::MessageExts
408
+ extend ::Google::Protobuf::MessageExts::ClassMethods
409
409
  end
410
410
 
411
411
  # A request to list data transfers configured for a BigQuery project.
412
412
  # @!attribute [rw] parent
413
- # @return [String]
413
+ # @return [::String]
414
414
  # Required. The BigQuery project id for which data sources
415
415
  # should be returned: `projects/{project_id}` or
416
416
  # `projects/{project_id}/locations/{location_id}`
417
417
  # @!attribute [rw] data_source_ids
418
- # @return [Array<String>]
418
+ # @return [::Array<::String>]
419
419
  # When specified, only configurations of requested data sources are returned.
420
420
  # @!attribute [rw] page_token
421
- # @return [String]
421
+ # @return [::String]
422
422
  # Pagination token, which can be used to request a specific page
423
423
  # of `ListTransfersRequest` list results. For multiple-page
424
424
  # results, `ListTransfersResponse` outputs
425
425
  # a `next_page` token, which can be used as the
426
426
  # `page_token` value to request the next page of list results.
427
427
  # @!attribute [rw] page_size
428
- # @return [Integer]
428
+ # @return [::Integer]
429
429
  # Page size. The default page size is the maximum value of 1000 results.
430
430
  class ListTransferConfigsRequest
431
- include Google::Protobuf::MessageExts
432
- extend Google::Protobuf::MessageExts::ClassMethods
431
+ include ::Google::Protobuf::MessageExts
432
+ extend ::Google::Protobuf::MessageExts::ClassMethods
433
433
  end
434
434
 
435
435
  # The returned list of pipelines in the project.
436
436
  # @!attribute [r] transfer_configs
437
- # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig>]
437
+ # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig>]
438
438
  # Output only. The stored pipeline transfer configurations.
439
439
  # @!attribute [r] next_page_token
440
- # @return [String]
440
+ # @return [::String]
441
441
  # Output only. The next-pagination token. For multiple-page list results,
442
442
  # this token can be used as the
443
443
  # `ListTransferConfigsRequest.page_token`
444
444
  # to request the next page of list results.
445
445
  class ListTransferConfigsResponse
446
- include Google::Protobuf::MessageExts
447
- extend Google::Protobuf::MessageExts::ClassMethods
446
+ include ::Google::Protobuf::MessageExts
447
+ extend ::Google::Protobuf::MessageExts::ClassMethods
448
448
  end
449
449
 
450
450
  # A request to list data transfer runs. UI can use this method to show/filter
451
451
  # specific data transfer runs. The data source can use this method to request
452
452
  # all scheduled transfer runs.
453
453
  # @!attribute [rw] parent
454
- # @return [String]
454
+ # @return [::String]
455
455
  # Required. Name of transfer configuration for which transfer runs should be retrieved.
456
456
  # Format of transfer configuration resource name is:
457
457
  # `projects/{project_id}/transferConfigs/{config_id}` or
458
458
  # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
459
459
  # @!attribute [rw] states
460
- # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferState>]
460
+ # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferState>]
461
461
  # When specified, only transfer runs with requested states are returned.
462
462
  # @!attribute [rw] page_token
463
- # @return [String]
463
+ # @return [::String]
464
464
  # Pagination token, which can be used to request a specific page
465
465
  # of `ListTransferRunsRequest` list results. For multiple-page
466
466
  # results, `ListTransferRunsResponse` outputs
467
467
  # a `next_page` token, which can be used as the
468
468
  # `page_token` value to request the next page of list results.
469
469
  # @!attribute [rw] page_size
470
- # @return [Integer]
470
+ # @return [::Integer]
471
471
  # Page size. The default page size is the maximum value of 1000 results.
472
472
  # @!attribute [rw] run_attempt
473
- # @return [Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest::RunAttempt]
473
+ # @return [::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest::RunAttempt]
474
474
  # Indicates how run attempts are to be pulled.
475
475
  class ListTransferRunsRequest
476
- include Google::Protobuf::MessageExts
477
- extend Google::Protobuf::MessageExts::ClassMethods
476
+ include ::Google::Protobuf::MessageExts
477
+ extend ::Google::Protobuf::MessageExts::ClassMethods
478
478
 
479
479
  # Represents which runs should be pulled.
480
480
  module RunAttempt
@@ -488,57 +488,57 @@ module Google
488
488
 
489
489
  # The returned list of pipelines in the project.
490
490
  # @!attribute [r] transfer_runs
491
- # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>]
491
+ # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>]
492
492
  # Output only. The stored pipeline transfer runs.
493
493
  # @!attribute [r] next_page_token
494
- # @return [String]
494
+ # @return [::String]
495
495
  # Output only. The next-pagination token. For multiple-page list results,
496
496
  # this token can be used as the
497
497
  # `ListTransferRunsRequest.page_token`
498
498
  # to request the next page of list results.
499
499
  class ListTransferRunsResponse
500
- include Google::Protobuf::MessageExts
501
- extend Google::Protobuf::MessageExts::ClassMethods
500
+ include ::Google::Protobuf::MessageExts
501
+ extend ::Google::Protobuf::MessageExts::ClassMethods
502
502
  end
503
503
 
504
504
  # A request to get user facing log messages associated with data transfer run.
505
505
  # @!attribute [rw] parent
506
- # @return [String]
506
+ # @return [::String]
507
507
  # Required. Transfer run name in the form:
508
508
  # `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
509
509
  # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
510
510
  # @!attribute [rw] page_token
511
- # @return [String]
511
+ # @return [::String]
512
512
  # Pagination token, which can be used to request a specific page
513
513
  # of `ListTransferLogsRequest` list results. For multiple-page
514
514
  # results, `ListTransferLogsResponse` outputs
515
515
  # a `next_page` token, which can be used as the
516
516
  # `page_token` value to request the next page of list results.
517
517
  # @!attribute [rw] page_size
518
- # @return [Integer]
518
+ # @return [::Integer]
519
519
  # Page size. The default page size is the maximum value of 1000 results.
520
520
  # @!attribute [rw] message_types
521
- # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage::MessageSeverity>]
521
+ # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage::MessageSeverity>]
522
522
  # Message types to return. If not populated - INFO, WARNING and ERROR
523
523
  # messages are returned.
524
524
  class ListTransferLogsRequest
525
- include Google::Protobuf::MessageExts
526
- extend Google::Protobuf::MessageExts::ClassMethods
525
+ include ::Google::Protobuf::MessageExts
526
+ extend ::Google::Protobuf::MessageExts::ClassMethods
527
527
  end
528
528
 
529
529
  # The returned list transfer run messages.
530
530
  # @!attribute [r] transfer_messages
531
- # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage>]
531
+ # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage>]
532
532
  # Output only. The stored pipeline transfer messages.
533
533
  # @!attribute [r] next_page_token
534
- # @return [String]
534
+ # @return [::String]
535
535
  # Output only. The next-pagination token. For multiple-page list results,
536
536
  # this token can be used as the
537
537
  # `GetTransferRunLogRequest.page_token`
538
538
  # to request the next page of list results.
539
539
  class ListTransferLogsResponse
540
- include Google::Protobuf::MessageExts
541
- extend Google::Protobuf::MessageExts::ClassMethods
540
+ include ::Google::Protobuf::MessageExts
541
+ extend ::Google::Protobuf::MessageExts::ClassMethods
542
542
  end
543
543
 
544
544
  # A request to determine whether the user has valid credentials. This method
@@ -548,96 +548,96 @@ module Google
548
548
  # returns false, as it cannot be determined whether the credentials are
549
549
  # already valid merely based on the user id.
550
550
  # @!attribute [rw] name
551
- # @return [String]
551
+ # @return [::String]
552
552
  # Required. The data source in the form:
553
553
  # `projects/{project_id}/dataSources/{data_source_id}` or
554
554
  # `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
555
555
  class CheckValidCredsRequest
556
- include Google::Protobuf::MessageExts
557
- extend Google::Protobuf::MessageExts::ClassMethods
556
+ include ::Google::Protobuf::MessageExts
557
+ extend ::Google::Protobuf::MessageExts::ClassMethods
558
558
  end
559
559
 
560
560
  # A response indicating whether the credentials exist and are valid.
561
561
  # @!attribute [rw] has_valid_creds
562
- # @return [Boolean]
562
+ # @return [::Boolean]
563
563
  # If set to `true`, the credentials exist and are valid.
564
564
  class CheckValidCredsResponse
565
- include Google::Protobuf::MessageExts
566
- extend Google::Protobuf::MessageExts::ClassMethods
565
+ include ::Google::Protobuf::MessageExts
566
+ extend ::Google::Protobuf::MessageExts::ClassMethods
567
567
  end
568
568
 
569
569
  # A request to schedule transfer runs for a time range.
570
570
  # @!attribute [rw] parent
571
- # @return [String]
571
+ # @return [::String]
572
572
  # Required. Transfer configuration name in the form:
573
573
  # `projects/{project_id}/transferConfigs/{config_id}` or
574
574
  # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
575
575
  # @!attribute [rw] start_time
576
- # @return [Google::Protobuf::Timestamp]
576
+ # @return [::Google::Protobuf::Timestamp]
577
577
  # Required. Start time of the range of transfer runs. For example,
578
578
  # `"2017-05-25T00:00:00+00:00"`.
579
579
  # @!attribute [rw] end_time
580
- # @return [Google::Protobuf::Timestamp]
580
+ # @return [::Google::Protobuf::Timestamp]
581
581
  # Required. End time of the range of transfer runs. For example,
582
582
  # `"2017-05-30T00:00:00+00:00"`.
583
583
  class ScheduleTransferRunsRequest
584
- include Google::Protobuf::MessageExts
585
- extend Google::Protobuf::MessageExts::ClassMethods
584
+ include ::Google::Protobuf::MessageExts
585
+ extend ::Google::Protobuf::MessageExts::ClassMethods
586
586
  end
587
587
 
588
588
  # A response to schedule transfer runs for a time range.
589
589
  # @!attribute [rw] runs
590
- # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>]
590
+ # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>]
591
591
  # The transfer runs that were scheduled.
592
592
  class ScheduleTransferRunsResponse
593
- include Google::Protobuf::MessageExts
594
- extend Google::Protobuf::MessageExts::ClassMethods
593
+ include ::Google::Protobuf::MessageExts
594
+ extend ::Google::Protobuf::MessageExts::ClassMethods
595
595
  end
596
596
 
597
597
  # A request to start manual transfer runs.
598
598
  # @!attribute [rw] parent
599
- # @return [String]
599
+ # @return [::String]
600
600
  # Transfer configuration name in the form:
601
601
  # `projects/{project_id}/transferConfigs/{config_id}` or
602
602
  # `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
603
603
  # @!attribute [rw] requested_time_range
604
- # @return [Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsRequest::TimeRange]
604
+ # @return [::Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsRequest::TimeRange]
605
605
  # Time range for the transfer runs that should be started.
606
606
  # @!attribute [rw] requested_run_time
607
- # @return [Google::Protobuf::Timestamp]
607
+ # @return [::Google::Protobuf::Timestamp]
608
608
  # Specific run_time for a transfer run to be started. The
609
609
  # requested_run_time must not be in the future.
610
610
  class StartManualTransferRunsRequest
611
- include Google::Protobuf::MessageExts
612
- extend Google::Protobuf::MessageExts::ClassMethods
611
+ include ::Google::Protobuf::MessageExts
612
+ extend ::Google::Protobuf::MessageExts::ClassMethods
613
613
 
614
614
  # A specification for a time range, this will request transfer runs with
615
615
  # run_time between start_time (inclusive) and end_time (exclusive).
616
616
  # @!attribute [rw] start_time
617
- # @return [Google::Protobuf::Timestamp]
617
+ # @return [::Google::Protobuf::Timestamp]
618
618
  # Start time of the range of transfer runs. For example,
619
619
  # `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than
620
620
  # the end_time. Creates transfer runs where run_time is in the range betwen
621
621
  # start_time (inclusive) and end_time (exlusive).
622
622
  # @!attribute [rw] end_time
623
- # @return [Google::Protobuf::Timestamp]
623
+ # @return [::Google::Protobuf::Timestamp]
624
624
  # End time of the range of transfer runs. For example,
625
625
  # `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future.
626
626
  # Creates transfer runs where run_time is in the range betwen start_time
627
627
  # (inclusive) and end_time (exlusive).
628
628
  class TimeRange
629
- include Google::Protobuf::MessageExts
630
- extend Google::Protobuf::MessageExts::ClassMethods
629
+ include ::Google::Protobuf::MessageExts
630
+ extend ::Google::Protobuf::MessageExts::ClassMethods
631
631
  end
632
632
  end
633
633
 
634
634
  # A response to start manual transfer runs.
635
635
  # @!attribute [rw] runs
636
- # @return [Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>]
636
+ # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>]
637
637
  # The transfer runs that were created.
638
638
  class StartManualTransferRunsResponse
639
- include Google::Protobuf::MessageExts
640
- extend Google::Protobuf::MessageExts::ClassMethods
639
+ include ::Google::Protobuf::MessageExts
640
+ extend ::Google::Protobuf::MessageExts::ClassMethods
641
641
  end
642
642
  end
643
643
  end