google-cloud-bigquery-connection-v1 0.15.1 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (10) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/bigquery/connection/v1/connection_service/client.rb +41 -9
  4. data/lib/google/cloud/bigquery/connection/v1/connection_service/rest/client.rb +165 -7
  5. data/lib/google/cloud/bigquery/connection/v1/connection_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/bigquery/connection/v1/version.rb +1 -1
  7. data/proto_docs/google/api/client.rb +14 -0
  8. data/proto_docs/google/api/field_behavior.rb +14 -0
  9. data/proto_docs/google/cloud/bigquery/connection/v1/connection.rb +1 -0
  10. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 137eff89dfa94e496cd8a778448bc7a8193d6fac39113daeaf64c4327a05f4cf
4
- data.tar.gz: 39ebca9db2bba43ca26d3a768feaaf06c4686efb9b6ec020722f42fec713b5c6
3
+ metadata.gz: 47aa6f8d5e72e5a6574676b64de9094423a067ec175cd89f118a2a61f0bbd315
4
+ data.tar.gz: 9e7f0cd90604f899a55b0a6b2a092850ddb06e3658b0c58c8f1fdca75b21effd
5
5
  SHA512:
6
- metadata.gz: fe6dd1e8106d1282d296317a59825bd7be48a78632a8e1bf6bf85106f68a49129fd1ed6362b79ceee755bfd87ccdab6bf034294eaa47d0af4083af29c64efc20
7
- data.tar.gz: 2bc84ef5e5b0e5a6f268bb8a0a1436b1edb4f4b7f0bbd17746c75d94f28ffba359699dadb38fa5b02dc4d2741eb23ff924dc9cd8787b44203ff28b69185296d1
6
+ metadata.gz: aa6652c3d60acf4154f7c33799b49a8c3dd0832f9cea39bea9e645252eda08d5a6f07d73cf933758bd2767943213aebb86abd95d1b12552ab4647f6dc420eeee
7
+ data.tar.gz: 2032f145bd7b00dd8a538c0696d39f9d9df7bcf6170ac489ec1b9457ad36d2b3885f0dda15a2f10cf53db9a9196b45725c9cd2b05b3766a4383129078f53c82e
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-bigquery-connection-v1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-bigquery-connection-v1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export BIGQUERY_CONNECTION_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/bigquery/connection/v1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-bigquery-connection-v1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-bigquery-connection-v1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-bigquery-connection-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `BIGQUERY_CONNECTION_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `BIGQUERY_CONNECTION_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
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
74
41
 
75
- ```ruby
76
- require "google/cloud/bigquery/connection/v1"
77
-
78
- ENV["BIGQUERY_CONNECTION_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new
81
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
82
49
 
83
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
84
53
 
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:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/bigquery/connection/v1"
90
58
 
91
59
  client = ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/bigquery/connection/v1"
100
68
 
101
69
  ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
113
82
 
114
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-bigquery-connection-v1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/bigquery/connection/v1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-bigquery-connection-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
134
- 2. Create a new project or click on an existing project.
135
- 3. Activate the menu in the upper left and select **APIs & Services**. From
136
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
137
107
 
138
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/lib/google/cloud/bigquery/connection/v1/connection_service/client.rb CHANGED
@@ -31,6 +31,9 @@ module Google
31
31
  # Manages external data source connections and credentials.
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "bigqueryconnection.$UNIVERSE_DOMAIN$"
36
+
34
37
  include Paths
35
38
 
36
39
  # @private
@@ -116,6 +119,15 @@ module Google
116
119
  @config
117
120
  end
118
121
 
122
+ ##
123
+ # The effective universe domain
124
+ #
125
+ # @return [String]
126
+ #
127
+ def universe_domain
128
+ @connection_service_stub.universe_domain
129
+ end
130
+
119
131
  ##
120
132
  # Create a new ConnectionService client object.
121
133
  #
@@ -149,8 +161,9 @@ module Google
149
161
  credentials = @config.credentials
150
162
  # Use self-signed JWT if the endpoint is unchanged from default,
151
163
  # but only if the default endpoint does not have a region prefix.
152
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
153
- !@config.endpoint.split(".").first.include?("-")
164
+ enable_self_signed_jwt = @config.endpoint.nil? ||
165
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
166
+ !@config.endpoint.split(".").first.include?("-"))
154
167
  credentials ||= Credentials.default scope: @config.scope,
155
168
  enable_self_signed_jwt: enable_self_signed_jwt
156
169
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -161,10 +174,13 @@ module Google
161
174
 
162
175
  @connection_service_stub = ::Gapic::ServiceStub.new(
163
176
  ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Stub,
164
- credentials: credentials,
165
- endpoint: @config.endpoint,
177
+ credentials: credentials,
178
+ endpoint: @config.endpoint,
179
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
180
+ universe_domain: @config.universe_domain,
166
181
  channel_args: @config.channel_args,
167
- interceptors: @config.interceptors
182
+ interceptors: @config.interceptors,
183
+ channel_pool_config: @config.channel_pool
168
184
  )
169
185
  end
170
186
 
@@ -936,9 +952,9 @@ module Google
936
952
  # end
937
953
  #
938
954
  # @!attribute [rw] endpoint
939
- # The hostname or hostname:port of the service endpoint.
940
- # Defaults to `"bigqueryconnection.googleapis.com"`.
941
- # @return [::String]
955
+ # A custom service endpoint, as a hostname or hostname:port. The default is
956
+ # nil, indicating to use the default endpoint in the current universe domain.
957
+ # @return [::String,nil]
942
958
  # @!attribute [rw] credentials
943
959
  # Credentials to send with calls. You may provide any of the following types:
944
960
  # * (`String`) The path to a service account key file in JSON format
@@ -984,13 +1000,20 @@ module Google
984
1000
  # @!attribute [rw] quota_project
985
1001
  # A separate project against which to charge quota.
986
1002
  # @return [::String]
1003
+ # @!attribute [rw] universe_domain
1004
+ # The universe domain within which to make requests. This determines the
1005
+ # default endpoint URL. The default value of nil uses the environment
1006
+ # universe (usually the default "googleapis.com" universe).
1007
+ # @return [::String,nil]
987
1008
  #
988
1009
  class Configuration
989
1010
  extend ::Gapic::Config
990
1011
 
1012
+ # @private
1013
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
991
1014
  DEFAULT_ENDPOINT = "bigqueryconnection.googleapis.com"
992
1015
 
993
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1016
+ config_attr :endpoint, nil, ::String, nil
994
1017
  config_attr :credentials, nil do |value|
995
1018
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
996
1019
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1005,6 +1028,7 @@ module Google
1005
1028
  config_attr :metadata, nil, ::Hash, nil
1006
1029
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1007
1030
  config_attr :quota_project, nil, ::String, nil
1031
+ config_attr :universe_domain, nil, ::String, nil
1008
1032
 
1009
1033
  # @private
1010
1034
  def initialize parent_config = nil
@@ -1025,6 +1049,14 @@ module Google
1025
1049
  end
1026
1050
  end
1027
1051
 
1052
+ ##
1053
+ # Configuration for the channel pool
1054
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
1055
+ #
1056
+ def channel_pool
1057
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
1058
+ end
1059
+
1028
1060
  ##
1029
1061
  # Configuration RPC class for the ConnectionService API.
1030
1062
  #
data/lib/google/cloud/bigquery/connection/v1/connection_service/rest/client.rb CHANGED
@@ -33,6 +33,9 @@ module Google
33
33
  # Manages external data source connections and credentials.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "bigqueryconnection.$UNIVERSE_DOMAIN$"
38
+
36
39
  include Paths
37
40
 
38
41
  # @private
@@ -118,6 +121,15 @@ module Google
118
121
  @config
119
122
  end
120
123
 
124
+ ##
125
+ # The effective universe domain
126
+ #
127
+ # @return [String]
128
+ #
129
+ def universe_domain
130
+ @connection_service_stub.universe_domain
131
+ end
132
+
121
133
  ##
122
134
  # Create a new ConnectionService REST client object.
123
135
  #
@@ -145,8 +157,9 @@ module Google
145
157
  credentials = @config.credentials
146
158
  # Use self-signed JWT if the endpoint is unchanged from default,
147
159
  # but only if the default endpoint does not have a region prefix.
148
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
149
- !@config.endpoint.split(".").first.include?("-")
160
+ enable_self_signed_jwt = @config.endpoint.nil? ||
161
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
162
+ !@config.endpoint.split(".").first.include?("-"))
150
163
  credentials ||= Credentials.default scope: @config.scope,
151
164
  enable_self_signed_jwt: enable_self_signed_jwt
152
165
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -156,7 +169,12 @@ module Google
156
169
  @quota_project_id = @config.quota_project
157
170
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
158
171
 
159
- @connection_service_stub = ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
172
+ @connection_service_stub = ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Rest::ServiceStub.new(
173
+ endpoint: @config.endpoint,
174
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
175
+ universe_domain: @config.universe_domain,
176
+ credentials: credentials
177
+ )
160
178
  end
161
179
 
162
180
  # Service calls
@@ -193,6 +211,22 @@ module Google
193
211
  # @return [::Google::Cloud::Bigquery::Connection::V1::Connection]
194
212
  #
195
213
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
214
+ #
215
+ # @example Basic example
216
+ # require "google/cloud/bigquery/connection/v1"
217
+ #
218
+ # # Create a client object. The client can be reused for multiple calls.
219
+ # client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Rest::Client.new
220
+ #
221
+ # # Create a request. To set request fields, pass in keyword arguments.
222
+ # request = Google::Cloud::Bigquery::Connection::V1::CreateConnectionRequest.new
223
+ #
224
+ # # Call the create_connection method.
225
+ # result = client.create_connection request
226
+ #
227
+ # # The returned object is of type Google::Cloud::Bigquery::Connection::V1::Connection.
228
+ # p result
229
+ #
196
230
  def create_connection request, options = nil
197
231
  raise ::ArgumentError, "request must be provided" if request.nil?
198
232
 
@@ -256,6 +290,22 @@ module Google
256
290
  # @return [::Google::Cloud::Bigquery::Connection::V1::Connection]
257
291
  #
258
292
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
293
+ #
294
+ # @example Basic example
295
+ # require "google/cloud/bigquery/connection/v1"
296
+ #
297
+ # # Create a client object. The client can be reused for multiple calls.
298
+ # client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Rest::Client.new
299
+ #
300
+ # # Create a request. To set request fields, pass in keyword arguments.
301
+ # request = Google::Cloud::Bigquery::Connection::V1::GetConnectionRequest.new
302
+ #
303
+ # # Call the get_connection method.
304
+ # result = client.get_connection request
305
+ #
306
+ # # The returned object is of type Google::Cloud::Bigquery::Connection::V1::Connection.
307
+ # p result
308
+ #
259
309
  def get_connection request, options = nil
260
310
  raise ::ArgumentError, "request must be provided" if request.nil?
261
311
 
@@ -323,6 +373,26 @@ module Google
323
373
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::Connection::V1::Connection>]
324
374
  #
325
375
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
376
+ #
377
+ # @example Basic example
378
+ # require "google/cloud/bigquery/connection/v1"
379
+ #
380
+ # # Create a client object. The client can be reused for multiple calls.
381
+ # client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Rest::Client.new
382
+ #
383
+ # # Create a request. To set request fields, pass in keyword arguments.
384
+ # request = Google::Cloud::Bigquery::Connection::V1::ListConnectionsRequest.new
385
+ #
386
+ # # Call the list_connections method.
387
+ # result = client.list_connections request
388
+ #
389
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
390
+ # # over elements, and API calls will be issued to fetch pages as needed.
391
+ # result.each do |item|
392
+ # # Each element is of type ::Google::Cloud::Bigquery::Connection::V1::Connection.
393
+ # p item
394
+ # end
395
+ #
326
396
  def list_connections request, options = nil
327
397
  raise ::ArgumentError, "request must be provided" if request.nil?
328
398
 
@@ -392,6 +462,22 @@ module Google
392
462
  # @return [::Google::Cloud::Bigquery::Connection::V1::Connection]
393
463
  #
394
464
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
465
+ #
466
+ # @example Basic example
467
+ # require "google/cloud/bigquery/connection/v1"
468
+ #
469
+ # # Create a client object. The client can be reused for multiple calls.
470
+ # client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Rest::Client.new
471
+ #
472
+ # # Create a request. To set request fields, pass in keyword arguments.
473
+ # request = Google::Cloud::Bigquery::Connection::V1::UpdateConnectionRequest.new
474
+ #
475
+ # # Call the update_connection method.
476
+ # result = client.update_connection request
477
+ #
478
+ # # The returned object is of type Google::Cloud::Bigquery::Connection::V1::Connection.
479
+ # p result
480
+ #
395
481
  def update_connection request, options = nil
396
482
  raise ::ArgumentError, "request must be provided" if request.nil?
397
483
 
@@ -455,6 +541,22 @@ module Google
455
541
  # @return [::Google::Protobuf::Empty]
456
542
  #
457
543
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
544
+ #
545
+ # @example Basic example
546
+ # require "google/cloud/bigquery/connection/v1"
547
+ #
548
+ # # Create a client object. The client can be reused for multiple calls.
549
+ # client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Rest::Client.new
550
+ #
551
+ # # Create a request. To set request fields, pass in keyword arguments.
552
+ # request = Google::Cloud::Bigquery::Connection::V1::DeleteConnectionRequest.new
553
+ #
554
+ # # Call the delete_connection method.
555
+ # result = client.delete_connection request
556
+ #
557
+ # # The returned object is of type Google::Protobuf::Empty.
558
+ # p result
559
+ #
458
560
  def delete_connection request, options = nil
459
561
  raise ::ArgumentError, "request must be provided" if request.nil?
460
562
 
@@ -523,6 +625,22 @@ module Google
523
625
  # @return [::Google::Iam::V1::Policy]
524
626
  #
525
627
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
628
+ #
629
+ # @example Basic example
630
+ # require "google/cloud/bigquery/connection/v1"
631
+ #
632
+ # # Create a client object. The client can be reused for multiple calls.
633
+ # client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Rest::Client.new
634
+ #
635
+ # # Create a request. To set request fields, pass in keyword arguments.
636
+ # request = Google::Iam::V1::GetIamPolicyRequest.new
637
+ #
638
+ # # Call the get_iam_policy method.
639
+ # result = client.get_iam_policy request
640
+ #
641
+ # # The returned object is of type Google::Iam::V1::Policy.
642
+ # p result
643
+ #
526
644
  def get_iam_policy request, options = nil
527
645
  raise ::ArgumentError, "request must be provided" if request.nil?
528
646
 
@@ -600,6 +718,22 @@ module Google
600
718
  # @return [::Google::Iam::V1::Policy]
601
719
  #
602
720
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
721
+ #
722
+ # @example Basic example
723
+ # require "google/cloud/bigquery/connection/v1"
724
+ #
725
+ # # Create a client object. The client can be reused for multiple calls.
726
+ # client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Rest::Client.new
727
+ #
728
+ # # Create a request. To set request fields, pass in keyword arguments.
729
+ # request = Google::Iam::V1::SetIamPolicyRequest.new
730
+ #
731
+ # # Call the set_iam_policy method.
732
+ # result = client.set_iam_policy request
733
+ #
734
+ # # The returned object is of type Google::Iam::V1::Policy.
735
+ # p result
736
+ #
603
737
  def set_iam_policy request, options = nil
604
738
  raise ::ArgumentError, "request must be provided" if request.nil?
605
739
 
@@ -674,6 +808,22 @@ module Google
674
808
  # @return [::Google::Iam::V1::TestIamPermissionsResponse]
675
809
  #
676
810
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
811
+ #
812
+ # @example Basic example
813
+ # require "google/cloud/bigquery/connection/v1"
814
+ #
815
+ # # Create a client object. The client can be reused for multiple calls.
816
+ # client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Rest::Client.new
817
+ #
818
+ # # Create a request. To set request fields, pass in keyword arguments.
819
+ # request = Google::Iam::V1::TestIamPermissionsRequest.new
820
+ #
821
+ # # Call the test_iam_permissions method.
822
+ # result = client.test_iam_permissions request
823
+ #
824
+ # # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
825
+ # p result
826
+ #
677
827
  def test_iam_permissions request, options = nil
678
828
  raise ::ArgumentError, "request must be provided" if request.nil?
679
829
 
@@ -739,9 +889,9 @@ module Google
739
889
  # end
740
890
  #
741
891
  # @!attribute [rw] endpoint
742
- # The hostname or hostname:port of the service endpoint.
743
- # Defaults to `"bigqueryconnection.googleapis.com"`.
744
- # @return [::String]
892
+ # A custom service endpoint, as a hostname or hostname:port. The default is
893
+ # nil, indicating to use the default endpoint in the current universe domain.
894
+ # @return [::String,nil]
745
895
  # @!attribute [rw] credentials
746
896
  # Credentials to send with calls. You may provide any of the following types:
747
897
  # * (`String`) The path to a service account key file in JSON format
@@ -778,13 +928,20 @@ module Google
778
928
  # @!attribute [rw] quota_project
779
929
  # A separate project against which to charge quota.
780
930
  # @return [::String]
931
+ # @!attribute [rw] universe_domain
932
+ # The universe domain within which to make requests. This determines the
933
+ # default endpoint URL. The default value of nil uses the environment
934
+ # universe (usually the default "googleapis.com" universe).
935
+ # @return [::String,nil]
781
936
  #
782
937
  class Configuration
783
938
  extend ::Gapic::Config
784
939
 
940
+ # @private
941
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
785
942
  DEFAULT_ENDPOINT = "bigqueryconnection.googleapis.com"
786
943
 
787
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
944
+ config_attr :endpoint, nil, ::String, nil
788
945
  config_attr :credentials, nil do |value|
789
946
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
790
947
  allowed.any? { |klass| klass === value }
@@ -796,6 +953,7 @@ module Google
796
953
  config_attr :metadata, nil, ::Hash, nil
797
954
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
798
955
  config_attr :quota_project, nil, ::String, nil
956
+ config_attr :universe_domain, nil, ::String, nil
799
957
 
800
958
  # @private
801
959
  def initialize parent_config = nil
data/lib/google/cloud/bigquery/connection/v1/connection_service/rest/service_stub.rb CHANGED
@@ -31,16 +31,28 @@ module Google
31
31
  # including transcoding, making the REST call, and deserialing the response.
32
32
  #
33
33
  class ServiceStub
34
- def initialize endpoint:, credentials:
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
35
35
  # These require statements are intentionally placed here to initialize
36
36
  # the REST modules only when it's required.
37
37
  require "gapic/rest"
38
38
 
39
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
39
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
40
+ endpoint_template: endpoint_template,
41
+ universe_domain: universe_domain,
42
+ credentials: credentials,
40
43
  numeric_enums: true,
41
44
  raise_faraday_errors: false
42
45
  end
43
46
 
47
+ ##
48
+ # The effective universe domain
49
+ #
50
+ # @return [String]
51
+ #
52
+ def universe_domain
53
+ @client_stub.universe_domain
54
+ end
55
+
44
56
  ##
45
57
  # Baseline implementation for the create_connection REST call
46
58
  #
data/lib/google/cloud/bigquery/connection/v1/version.rb CHANGED
@@ -22,7 +22,7 @@ module Google
22
22
  module Bigquery
23
23
  module Connection
24
24
  module V1
25
- VERSION = "0.15.1"
25
+ VERSION = "0.17.0"
26
26
  end
27
27
  end
28
28
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/api/field_behavior.rb CHANGED
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
data/proto_docs/google/cloud/bigquery/connection/v1/connection.rb CHANGED
@@ -255,6 +255,7 @@ module Google
255
255
 
256
256
  # Connection properties specific to Amazon Web Services (AWS).
257
257
  # @!attribute [rw] cross_account_role
258
+ # @deprecated This field is deprecated and may be removed in the next major version update.
258
259
  # @return [::Google::Cloud::Bigquery::Connection::V1::AwsCrossAccountRole]
259
260
  # Authentication using Google owned AWS IAM user's access key to assume
260
261
  # into customer's AWS IAM Role.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-bigquery-connection-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.15.1
4
+ version: 0.17.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-08-04 00:00:00.000000000 Z
11
+ date: 2024-01-11 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.19.1
19
+ version: 0.21.1
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.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -228,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
228
228
  - !ruby/object:Gem::Version
229
229
  version: '0'
230
230
  requirements: []
231
- rubygems_version: 3.4.2
231
+ rubygems_version: 3.5.3
232
232
  signing_key:
233
233
  specification_version: 4
234
234
  summary: Allows users to manage BigQuery connections to external data sources.