google-cloud-bigquery-data_transfer-v1 0.6.0 → 0.6.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0d3f6c8c15ca8faff1299d946c2a6ca716bc17b770eb2412765a3074d9089b7f
4
- data.tar.gz: 393a5f7da248e86dc0b85174295c300838faaeaba5f06cd6221fea22cd2c556a
3
+ metadata.gz: 9cedc5fbb9cbf2090b2c5bc7b219f925dfe86bf2d8f99ae70d7bc216fa2bb2e9
4
+ data.tar.gz: bb56f3091662f249247c42d0142271a8360781fe77c8aa582f41e24a318ad992
5
5
  SHA512:
6
- metadata.gz: e745340a4b582f05927a65c8717b936831cc58f436ce61b5bfba2bfc4e4a928174da082f1c407f59bbbbb07accab236492403ee3e97cf4c1fdfbb1580dc882c4
7
- data.tar.gz: bf8fab631237c803b71212bf01f0375a8e078dc592d0eb49ed9ea3f5d2fdb11e363db67ec3804e8f8cc06e091ecc8bab2f60eeb90d5a93441a9927d1c89d1dfb
6
+ metadata.gz: deb680d8ef213d6ac7265a649560aa1ba1c2165da809d0edd7bff7526393c6be8accba24a4a4ba7c1498289f2589fd352fa786b926d0056302ec4b556a1421ce
7
+ data.tar.gz: 21bff486fc31a8bb701224cf0245d73299e3b6e6023bcf1f900312ee393a011615ce64fb342f5aaeae9d2120de102068f44887e1c34430b524d90bc099509085
data/AUTHENTICATION.md CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
114
114
  To configure your system for this, simply:
115
115
 
116
116
  1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
117
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
118
  3. Write code as if already authenticated.
119
119
 
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
@@ -309,7 +309,7 @@ module Google
309
309
  # @param parent [::String]
310
310
  # Required. The BigQuery project id for which data sources should be returned.
311
311
  # Must be in the form: `projects/{project_id}` or
312
- # `projects/{project_id}/locations/{location_id}
312
+ # `projects/{project_id}/locations/{location_id}`
313
313
  # @param page_token [::String]
314
314
  # Pagination token, which can be used to request a specific page
315
315
  # of `ListDataSourcesRequest` list results. For multiple-page
@@ -417,34 +417,45 @@ module Google
417
417
  # Required. Data transfer configuration to create.
418
418
  # @param authorization_code [::String]
419
419
  # Optional OAuth2 authorization code to use with this transfer configuration.
420
- # This is required if new credentials are needed, as indicated by
421
- # `CheckValidCreds`.
422
- # In order to obtain authorization_code, please make a
423
- # request to
424
- # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
425
- #
426
- # * client_id should be OAuth client_id of BigQuery DTS API for the given
427
- # data source returned by ListDataSources method.
428
- # * data_source_scopes are the scopes returned by ListDataSources method.
429
- # * redirect_uri is an optional parameter. If not specified, then
430
- # authorization code is posted to the opener of authorization flow window.
431
- # Otherwise it will be sent to the redirect uri. A special value of
432
- # urn:ietf:wg:oauth:2.0:oob means that authorization code should be
433
- # returned in the title bar of the browser, with the page text prompting
434
- # the user to copy the code and paste it in the application.
420
+ # This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
421
+ # and new credentials are needed, as indicated by `CheckValidCreds`. In order
422
+ # to obtain authorization_code, make a request to the following URL:
423
+ # <pre class="prettyprint" suppresswarning="true">
424
+ # 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>
425
+ # </pre>
426
+ # * The <var>client_id</var> is the OAuth client_id of the a data source as
427
+ # returned by ListDataSources method.
428
+ # * <var>data_source_scopes</var> are the scopes returned by ListDataSources
429
+ # method.
430
+ #
431
+ # Note that this should not be set when `service_account_name` is used to
432
+ # create the transfer config.
435
433
  # @param version_info [::String]
436
- # Optional version info. If users want to find a very recent access token,
437
- # that is, immediately after approving access, users have to set the
438
- # version_info claim in the token request. To obtain the version_info, users
439
- # must use the "none+gsession" response type. which be return a
440
- # version_info back in the authorization response which be be put in a JWT
441
- # claim in the token request.
434
+ # Optional version info. This is required only if
435
+ # `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
436
+ # are needed, as indicated by `CheckValidCreds`. In order to obtain version
437
+ # info, make a request to the following URL:
438
+ # <pre class="prettyprint" suppresswarning="true">
439
+ # 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>
440
+ # </pre>
441
+ # * The <var>client_id</var> is the OAuth client_id of the a data source as
442
+ # returned by ListDataSources method.
443
+ # * <var>data_source_scopes</var> are the scopes returned by ListDataSources
444
+ # method.
445
+ #
446
+ # Note that this should not be set when `service_account_name` is used to
447
+ # create the transfer config.
442
448
  # @param service_account_name [::String]
443
- # Optional service account name. If this field is set, transfer config will
444
- # be created with this service account credentials. It requires that
445
- # requesting user calling this API has permissions to act as this service
449
+ # Optional service account name. If this field is set, the transfer config
450
+ # will be created with this service account's credentials. It requires that
451
+ # the requesting user calling this API has permissions to act as this service
446
452
  # account.
447
453
  #
454
+ # Note that not all data sources support service account credentials when
455
+ # creating a transfer config. For the latest list of data sources, read about
456
+ # [using service
457
+ # accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
458
+ #
448
459
  # @yield [response, operation] Access the result along with the RPC operation
449
460
  # @yieldparam response [::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
450
461
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
@@ -532,37 +543,47 @@ module Google
532
543
  # Required. Data transfer configuration to create.
533
544
  # @param authorization_code [::String]
534
545
  # Optional OAuth2 authorization code to use with this transfer configuration.
535
- # If it is provided, the transfer configuration will be associated with the
536
- # authorizing user.
537
- # In order to obtain authorization_code, please make a
538
- # request to
539
- # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
540
- #
541
- # * client_id should be OAuth client_id of BigQuery DTS API for the given
542
- # data source returned by ListDataSources method.
543
- # * data_source_scopes are the scopes returned by ListDataSources method.
544
- # * redirect_uri is an optional parameter. If not specified, then
545
- # authorization code is posted to the opener of authorization flow window.
546
- # Otherwise it will be sent to the redirect uri. A special value of
547
- # urn:ietf:wg:oauth:2.0:oob means that authorization code should be
548
- # returned in the title bar of the browser, with the page text prompting
549
- # the user to copy the code and paste it in the application.
546
+ # This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
547
+ # and new credentials are needed, as indicated by `CheckValidCreds`. In order
548
+ # to obtain authorization_code, make a request to the following URL:
549
+ # <pre class="prettyprint" suppresswarning="true">
550
+ # 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>
551
+ # </pre>
552
+ # * The <var>client_id</var> is the OAuth client_id of the a data source as
553
+ # returned by ListDataSources method.
554
+ # * <var>data_source_scopes</var> are the scopes returned by ListDataSources
555
+ # method.
556
+ #
557
+ # Note that this should not be set when `service_account_name` is used to
558
+ # update the transfer config.
550
559
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
551
560
  # Required. Required list of fields to be updated in this request.
552
561
  # @param version_info [::String]
553
- # Optional version info. If users want to find a very recent access token,
554
- # that is, immediately after approving access, users have to set the
555
- # version_info claim in the token request. To obtain the version_info, users
556
- # must use the "none+gsession" response type. which be return a
557
- # version_info back in the authorization response which be be put in a JWT
558
- # claim in the token request.
562
+ # Optional version info. This is required only if
563
+ # `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
564
+ # are needed, as indicated by `CheckValidCreds`. In order to obtain version
565
+ # info, make a request to the following URL:
566
+ # <pre class="prettyprint" suppresswarning="true">
567
+ # 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>
568
+ # </pre>
569
+ # * The <var>client_id</var> is the OAuth client_id of the a data source as
570
+ # returned by ListDataSources method.
571
+ # * <var>data_source_scopes</var> are the scopes returned by ListDataSources
572
+ # method.
573
+ #
574
+ # Note that this should not be set when `service_account_name` is used to
575
+ # update the transfer config.
559
576
  # @param service_account_name [::String]
560
- # Optional service account name. If this field is set and
561
- # "service_account_name" is set in update_mask, transfer config will be
562
- # updated to use this service account credentials. It requires that
563
- # requesting user calling this API has permissions to act as this service
577
+ # Optional service account name. If this field is set, the transfer config
578
+ # will be created with this service account's credentials. It requires that
579
+ # the requesting user calling this API has permissions to act as this service
564
580
  # account.
565
581
  #
582
+ # Note that not all data sources support service account credentials when
583
+ # creating a transfer config. For the latest list of data sources, read about
584
+ # [using service
585
+ # accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
586
+ #
566
587
  # @yield [response, operation] Access the result along with the RPC operation
567
588
  # @yieldparam response [::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
568
589
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
@@ -822,7 +843,7 @@ module Google
822
843
  # the default parameter values, pass an empty Hash as a request object (see above).
823
844
  #
824
845
  # @param parent [::String]
825
- # Required. The BigQuery project id for which data sources
846
+ # Required. The BigQuery project id for which transfer configs
826
847
  # should be returned: `projects/{project_id}` or
827
848
  # `projects/{project_id}/locations/{location_id}`
828
849
  # @param data_source_ids [::Array<::String>]
@@ -1578,10 +1599,12 @@ module Google
1578
1599
  ##
1579
1600
  # Enroll data sources in a user project. This allows users to create transfer
1580
1601
  # configurations for these data sources. They will also appear in the
1581
- # ListDataSources RPC and as such, will appear in the BigQuery UI
1582
- # 'https://bigquery.cloud.google.com' (and the documents can be found at
1583
- # https://cloud.google.com/bigquery/bigquery-web-ui and
1584
- # https://cloud.google.com/bigquery/docs/working-with-transfers).
1602
+ # ListDataSources RPC and as such, will appear in the
1603
+ # [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents
1604
+ # can be found in the public guide for
1605
+ # [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and
1606
+ # [Data Transfer
1607
+ # Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
1585
1608
  #
1586
1609
  # @overload enroll_data_sources(request, options = nil)
1587
1610
  # Pass arguments to `enroll_data_sources` via a request object, either of type
@@ -1599,8 +1622,7 @@ module Google
1599
1622
  # the default parameter values, pass an empty Hash as a request object (see above).
1600
1623
  #
1601
1624
  # @param name [::String]
1602
- # The name of the project resource in the form:
1603
- # `projects/{project_id}`
1625
+ # The name of the project resource in the form: `projects/{project_id}`
1604
1626
  # @param data_source_ids [::Array<::String>]
1605
1627
  # Data sources that are enrolled. It is required to provide at least one
1606
1628
  # data source id.
@@ -22,7 +22,7 @@ module Google
22
22
  module Bigquery
23
23
  module DataTransfer
24
24
  module V1
25
- VERSION = "0.6.0"
25
+ VERSION = "0.6.1"
26
26
  end
27
27
  end
28
28
  end
@@ -75,10 +75,12 @@ module Google
75
75
  rpc :CheckValidCreds, ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsRequest, ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse
76
76
  # Enroll data sources in a user project. This allows users to create transfer
77
77
  # configurations for these data sources. They will also appear in the
78
- # ListDataSources RPC and as such, will appear in the BigQuery UI
79
- # 'https://bigquery.cloud.google.com' (and the documents can be found at
80
- # https://cloud.google.com/bigquery/bigquery-web-ui and
81
- # https://cloud.google.com/bigquery/docs/working-with-transfers).
78
+ # ListDataSources RPC and as such, will appear in the
79
+ # [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents
80
+ # can be found in the public guide for
81
+ # [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and
82
+ # [Data Transfer
83
+ # Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
82
84
  rpc :EnrollDataSources, ::Google::Cloud::Bigquery::DataTransfer::V1::EnrollDataSourcesRequest, ::Google::Protobuf::Empty
83
85
  end
84
86
 
@@ -0,0 +1,318 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end
@@ -52,7 +52,7 @@ module Google
52
52
  # For integer and double values specifies minimum allowed value.
53
53
  # @!attribute [rw] max_value
54
54
  # @return [::Google::Protobuf::DoubleValue]
55
- # For integer and double values specifies maxminum allowed value.
55
+ # For integer and double values specifies maximum allowed value.
56
56
  # @!attribute [rw] fields
57
57
  # @return [::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>]
58
58
  # Deprecated. This field has no effect.
@@ -226,7 +226,7 @@ module Google
226
226
  # @return [::String]
227
227
  # Required. The BigQuery project id for which data sources should be returned.
228
228
  # Must be in the form: `projects/{project_id}` or
229
- # `projects/{project_id}/locations/{location_id}
229
+ # `projects/{project_id}/locations/{location_id}`
230
230
  # @!attribute [rw] page_token
231
231
  # @return [::String]
232
232
  # Pagination token, which can be used to request a specific page
@@ -258,9 +258,9 @@ module Google
258
258
  end
259
259
 
260
260
  # A request to create a data transfer configuration. If new credentials are
261
- # needed for this transfer configuration, an authorization code must be
262
- # provided. If an authorization code is provided, the transfer configuration
263
- # will be associated with the user id corresponding to the authorization code.
261
+ # needed for this transfer configuration, authorization info must be provided.
262
+ # If authorization info is provided, the transfer configuration will be
263
+ # associated with the user id corresponding to the authorization info.
264
264
  # Otherwise, the transfer configuration will be associated with the calling
265
265
  # user.
266
266
  # @!attribute [rw] parent
@@ -275,81 +275,102 @@ module Google
275
275
  # @!attribute [rw] authorization_code
276
276
  # @return [::String]
277
277
  # Optional OAuth2 authorization code to use with this transfer configuration.
278
- # This is required if new credentials are needed, as indicated by
279
- # `CheckValidCreds`.
280
- # In order to obtain authorization_code, please make a
281
- # request to
282
- # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
278
+ # This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
279
+ # and new credentials are needed, as indicated by `CheckValidCreds`. In order
280
+ # to obtain authorization_code, make a request to the following URL:
281
+ # <pre class="prettyprint" suppresswarning="true">
282
+ # 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>
283
+ # </pre>
284
+ # * The <var>client_id</var> is the OAuth client_id of the a data source as
285
+ # returned by ListDataSources method.
286
+ # * <var>data_source_scopes</var> are the scopes returned by ListDataSources
287
+ # method.
283
288
  #
284
- # * client_id should be OAuth client_id of BigQuery DTS API for the given
285
- # data source returned by ListDataSources method.
286
- # * data_source_scopes are the scopes returned by ListDataSources method.
287
- # * redirect_uri is an optional parameter. If not specified, then
288
- # authorization code is posted to the opener of authorization flow window.
289
- # Otherwise it will be sent to the redirect uri. A special value of
290
- # urn:ietf:wg:oauth:2.0:oob means that authorization code should be
291
- # returned in the title bar of the browser, with the page text prompting
292
- # the user to copy the code and paste it in the application.
289
+ # Note that this should not be set when `service_account_name` is used to
290
+ # create the transfer config.
293
291
  # @!attribute [rw] version_info
294
292
  # @return [::String]
295
- # Optional version info. If users want to find a very recent access token,
296
- # that is, immediately after approving access, users have to set the
297
- # version_info claim in the token request. To obtain the version_info, users
298
- # must use the "none+gsession" response type. which be return a
299
- # version_info back in the authorization response which be be put in a JWT
300
- # claim in the token request.
293
+ # Optional version info. This is required only if
294
+ # `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
295
+ # are needed, as indicated by `CheckValidCreds`. In order to obtain version
296
+ # info, make a request to the following URL:
297
+ # <pre class="prettyprint" suppresswarning="true">
298
+ # 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>
299
+ # </pre>
300
+ # * The <var>client_id</var> is the OAuth client_id of the a data source as
301
+ # returned by ListDataSources method.
302
+ # * <var>data_source_scopes</var> are the scopes returned by ListDataSources
303
+ # method.
304
+ #
305
+ # Note that this should not be set when `service_account_name` is used to
306
+ # create the transfer config.
301
307
  # @!attribute [rw] service_account_name
302
308
  # @return [::String]
303
- # Optional service account name. If this field is set, transfer config will
304
- # be created with this service account credentials. It requires that
305
- # requesting user calling this API has permissions to act as this service
309
+ # Optional service account name. If this field is set, the transfer config
310
+ # will be created with this service account's credentials. It requires that
311
+ # the requesting user calling this API has permissions to act as this service
306
312
  # account.
313
+ #
314
+ # Note that not all data sources support service account credentials when
315
+ # creating a transfer config. For the latest list of data sources, read about
316
+ # [using service
317
+ # accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
307
318
  class CreateTransferConfigRequest
308
319
  include ::Google::Protobuf::MessageExts
309
320
  extend ::Google::Protobuf::MessageExts::ClassMethods
310
321
  end
311
322
 
312
323
  # A request to update a transfer configuration. To update the user id of the
313
- # transfer configuration, an authorization code needs to be provided.
324
+ # transfer configuration, authorization info needs to be provided.
314
325
  # @!attribute [rw] transfer_config
315
326
  # @return [::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig]
316
327
  # Required. Data transfer configuration to create.
317
328
  # @!attribute [rw] authorization_code
318
329
  # @return [::String]
319
330
  # Optional OAuth2 authorization code to use with this transfer configuration.
320
- # If it is provided, the transfer configuration will be associated with the
321
- # authorizing user.
322
- # In order to obtain authorization_code, please make a
323
- # request to
324
- # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
331
+ # This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
332
+ # and new credentials are needed, as indicated by `CheckValidCreds`. In order
333
+ # to obtain authorization_code, make a request to the following URL:
334
+ # <pre class="prettyprint" suppresswarning="true">
335
+ # 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>
336
+ # </pre>
337
+ # * The <var>client_id</var> is the OAuth client_id of the a data source as
338
+ # returned by ListDataSources method.
339
+ # * <var>data_source_scopes</var> are the scopes returned by ListDataSources
340
+ # method.
325
341
  #
326
- # * client_id should be OAuth client_id of BigQuery DTS API for the given
327
- # data source returned by ListDataSources method.
328
- # * data_source_scopes are the scopes returned by ListDataSources method.
329
- # * redirect_uri is an optional parameter. If not specified, then
330
- # authorization code is posted to the opener of authorization flow window.
331
- # Otherwise it will be sent to the redirect uri. A special value of
332
- # urn:ietf:wg:oauth:2.0:oob means that authorization code should be
333
- # returned in the title bar of the browser, with the page text prompting
334
- # the user to copy the code and paste it in the application.
342
+ # Note that this should not be set when `service_account_name` is used to
343
+ # update the transfer config.
335
344
  # @!attribute [rw] update_mask
336
345
  # @return [::Google::Protobuf::FieldMask]
337
346
  # Required. Required list of fields to be updated in this request.
338
347
  # @!attribute [rw] version_info
339
348
  # @return [::String]
340
- # Optional version info. If users want to find a very recent access token,
341
- # that is, immediately after approving access, users have to set the
342
- # version_info claim in the token request. To obtain the version_info, users
343
- # must use the "none+gsession" response type. which be return a
344
- # version_info back in the authorization response which be be put in a JWT
345
- # claim in the token request.
349
+ # Optional version info. This is required only if
350
+ # `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
351
+ # are needed, as indicated by `CheckValidCreds`. In order to obtain version
352
+ # info, make a request to the following URL:
353
+ # <pre class="prettyprint" suppresswarning="true">
354
+ # 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>
355
+ # </pre>
356
+ # * The <var>client_id</var> is the OAuth client_id of the a data source as
357
+ # returned by ListDataSources method.
358
+ # * <var>data_source_scopes</var> are the scopes returned by ListDataSources
359
+ # method.
360
+ #
361
+ # Note that this should not be set when `service_account_name` is used to
362
+ # update the transfer config.
346
363
  # @!attribute [rw] service_account_name
347
364
  # @return [::String]
348
- # Optional service account name. If this field is set and
349
- # "service_account_name" is set in update_mask, transfer config will be
350
- # updated to use this service account credentials. It requires that
351
- # requesting user calling this API has permissions to act as this service
365
+ # Optional service account name. If this field is set, the transfer config
366
+ # will be created with this service account's credentials. It requires that
367
+ # the requesting user calling this API has permissions to act as this service
352
368
  # account.
369
+ #
370
+ # Note that not all data sources support service account credentials when
371
+ # creating a transfer config. For the latest list of data sources, read about
372
+ # [using service
373
+ # accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
353
374
  class UpdateTransferConfigRequest
354
375
  include ::Google::Protobuf::MessageExts
355
376
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -403,7 +424,7 @@ module Google
403
424
  # A request to list data transfers configured for a BigQuery project.
404
425
  # @!attribute [rw] parent
405
426
  # @return [::String]
406
- # Required. The BigQuery project id for which data sources
427
+ # Required. The BigQuery project id for which transfer configs
407
428
  # should be returned: `projects/{project_id}` or
408
429
  # `projects/{project_id}/locations/{location_id}`
409
430
  # @!attribute [rw] data_source_ids
@@ -634,8 +655,7 @@ module Google
634
655
  # BigQuery UI's `Transfer` tab.
635
656
  # @!attribute [rw] name
636
657
  # @return [::String]
637
- # The name of the project resource in the form:
638
- # `projects/{project_id}`
658
+ # The name of the project resource in the form: `projects/{project_id}`
639
659
  # @!attribute [rw] data_source_ids
640
660
  # @return [::Array<::String>]
641
661
  # Data sources that are enrolled. It is required to provide at least one
@@ -88,7 +88,9 @@ module Google
88
88
  # User specified display name for the data transfer.
89
89
  # @!attribute [rw] data_source_id
90
90
  # @return [::String]
91
- # Data source id. Cannot be changed once data transfer is created.
91
+ # Data source ID. This cannot be changed once data transfer is created. The
92
+ # full list of available data source IDs can be returned through an API call:
93
+ # https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
92
94
  # @!attribute [rw] params
93
95
  # @return [::Google::Protobuf::Struct]
94
96
  # Parameters specific to each data source. For more information see the
@@ -26,8 +26,6 @@ module Google
26
26
  # service Foo {
27
27
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
28
28
  # }
29
- #
30
- # The JSON representation for `Empty` is empty JSON object `{}`.
31
29
  class Empty
32
30
  include ::Google::Protobuf::MessageExts
33
31
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
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.6.0
4
+ version: 0.6.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-07-01 00:00:00.000000000 Z
11
+ date: 2022-11-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.10'
19
+ version: '0.12'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.10'
29
+ version: '0.12'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -181,7 +181,9 @@ files:
181
181
  - lib/google/cloud/bigquery/datatransfer/v1/datatransfer_services_pb.rb
182
182
  - lib/google/cloud/bigquery/datatransfer/v1/transfer_pb.rb
183
183
  - proto_docs/README.md
184
+ - proto_docs/google/api/client.rb
184
185
  - proto_docs/google/api/field_behavior.rb
186
+ - proto_docs/google/api/launch_stage.rb
185
187
  - proto_docs/google/api/resource.rb
186
188
  - proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb
187
189
  - proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb