google-cloud-alloy_db-v1beta 0.4.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -99
  3. data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/client.rb +43 -13
  4. data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/operations.rb +28 -6
  5. data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/client.rb +45 -12
  6. data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/operations.rb +33 -8
  7. data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/alloy_db/v1beta/version.rb +1 -1
  9. data/lib/google/cloud/alloydb/v1beta/resources_pb.rb +3 -1
  10. data/lib/google/cloud/alloydb/v1beta/service_pb.rb +1 -1
  11. data/lib/google/cloud/alloydb/v1beta/service_services_pb.rb +4 -4
  12. data/proto_docs/google/api/client.rb +14 -0
  13. data/proto_docs/google/cloud/alloydb/v1beta/resources.rb +74 -15
  14. data/proto_docs/google/cloud/alloydb/v1beta/service.rb +6 -0
  15. metadata +9 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 546378e5ad5a89a6b6a7041d2781e5edb137a4646be36f65dfe39f18eba57aaf
4
- data.tar.gz: 268354cf93163992e72f96bb6b21b312173a6353cb9e975161f86caae0e71622
3
+ metadata.gz: 00e0d2e5a1e3b17fc45ec22013cfd5dc4d2198d35941fd717dfd96919bbd6f22
4
+ data.tar.gz: 6a528e30376b8619449acaad8c1c1cfede018ffaef3b52ce3c007283d25adc2e
5
5
  SHA512:
6
- metadata.gz: 6bf03fd7bf94330b8df385f487e103da9fef03b88f9bc6cff32e8d3ac15bf432aa091037144354e3f6dc7771759f7a3443560ac300ecb2e5b732500dbf238808
7
- data.tar.gz: 7736c85c05c8c29cc4220d5ec6e3487a2c3a8b394f6fb599666cee9646fba70a8d292b42d973ab6d781dfc51e0a1c65ed6d4741f1595662a0c6363bd3998b311
6
+ metadata.gz: 7abde37f3c54f3e05bfebe0ccd3f434a06154baaf22c105dbbe703fc57e83f5e930aa053c830ea183e922ac38c3e92431772801c54ad559700944905170b16e2
7
+ data.tar.gz: e1afe92a731c663825bae9a5fe8e460d6df11ca09abbfbc9ae66c8625fd6a55e0227ee5eca6c10317752ae25be321c48dd41ff5c8b6b3bef572ead08b1cffbbb
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-alloy_db-v1beta 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-alloy_db-v1beta 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 GOOGLE_CLOUD_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/alloy_db/v1beta"
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::AlloyDB::V1beta::AlloyDBAdmin::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-alloy_db-v1beta 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-alloy_db-v1beta 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-alloy_db-v1beta
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `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)
72
41
 
73
- ```ruby
74
- require "google/cloud/alloy_db/v1beta"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new
79
- ```
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).
80
49
 
81
- ### 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.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/alloy_db/v1beta"
88
58
 
89
59
  client = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/alloy_db/v1beta"
98
68
 
99
69
  ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- 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.
111
82
 
112
- 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).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 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-alloy_db-v1beta
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *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
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/alloy_db/v1beta"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-alloy_db-v1beta.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *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.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- 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.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- 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/alloy_db/v1beta/alloy_db_admin/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # Service describing handlers for resources
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "alloydb.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -149,6 +152,15 @@ module Google
149
152
  @config
150
153
  end
151
154
 
155
+ ##
156
+ # The effective universe domain
157
+ #
158
+ # @return [String]
159
+ #
160
+ def universe_domain
161
+ @alloy_db_admin_stub.universe_domain
162
+ end
163
+
152
164
  ##
153
165
  # Create a new AlloyDBAdmin client object.
154
166
  #
@@ -182,8 +194,9 @@ module Google
182
194
  credentials = @config.credentials
183
195
  # Use self-signed JWT if the endpoint is unchanged from default,
184
196
  # but only if the default endpoint does not have a region prefix.
185
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
186
- !@config.endpoint.split(".").first.include?("-")
197
+ enable_self_signed_jwt = @config.endpoint.nil? ||
198
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
199
+ !@config.endpoint.split(".").first.include?("-"))
187
200
  credentials ||= Credentials.default scope: @config.scope,
188
201
  enable_self_signed_jwt: enable_self_signed_jwt
189
202
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -196,24 +209,29 @@ module Google
196
209
  config.credentials = credentials
197
210
  config.quota_project = @quota_project_id
198
211
  config.endpoint = @config.endpoint
212
+ config.universe_domain = @config.universe_domain
199
213
  end
200
214
 
201
215
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
202
216
  config.credentials = credentials
203
217
  config.quota_project = @quota_project_id
204
218
  config.endpoint = @config.endpoint
219
+ config.universe_domain = @config.universe_domain
205
220
  end
206
221
 
207
222
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
208
223
  config.credentials = credentials
209
224
  config.quota_project = @quota_project_id
210
225
  config.endpoint = @config.endpoint
226
+ config.universe_domain = @config.universe_domain
211
227
  end
212
228
 
213
229
  @alloy_db_admin_stub = ::Gapic::ServiceStub.new(
214
230
  ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Stub,
215
- credentials: credentials,
216
- endpoint: @config.endpoint,
231
+ credentials: credentials,
232
+ endpoint: @config.endpoint,
233
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
234
+ universe_domain: @config.universe_domain,
217
235
  channel_args: @config.channel_args,
218
236
  interceptors: @config.interceptors,
219
237
  channel_pool_config: @config.channel_pool
@@ -2897,10 +2915,10 @@ module Google
2897
2915
 
2898
2916
  ##
2899
2917
  # Generate a client certificate signed by a Cluster CA.
2900
- # The sole purpose of this endpoint is to support the Auth Proxy client and
2901
- # the endpoint's behavior is subject to change without notice, so do not rely
2902
- # on its behavior remaining constant. Future changes will not break the Auth
2903
- # Proxy client.
2918
+ # The sole purpose of this endpoint is to support AlloyDB connectors and the
2919
+ # Auth Proxy client. The endpoint's behavior is subject to change without
2920
+ # notice, so do not rely on its behavior remaining constant. Future changes
2921
+ # will not break AlloyDB connectors or the Auth Proxy client.
2904
2922
  #
2905
2923
  # @overload generate_client_certificate(request, options = nil)
2906
2924
  # Pass arguments to `generate_client_certificate` via a request object, either of type
@@ -2912,7 +2930,7 @@ module Google
2912
2930
  # @param options [::Gapic::CallOptions, ::Hash]
2913
2931
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2914
2932
  #
2915
- # @overload generate_client_certificate(parent: nil, request_id: nil, pem_csr: nil, cert_duration: nil, public_key: nil)
2933
+ # @overload generate_client_certificate(parent: nil, request_id: nil, pem_csr: nil, cert_duration: nil, public_key: nil, use_metadata_exchange: nil)
2916
2934
  # Pass arguments to `generate_client_certificate` via keyword arguments. Note that at
2917
2935
  # least one keyword argument is required. To specify no parameters, or to keep all
2918
2936
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2944,6 +2962,10 @@ module Google
2944
2962
  # default duration.
2945
2963
  # @param public_key [::String]
2946
2964
  # Optional. The public key from the client.
2965
+ # @param use_metadata_exchange [::Boolean]
2966
+ # Optional. An optional hint to the endpoint to generate a client
2967
+ # ceritificate that can be used by AlloyDB connectors to exchange additional
2968
+ # metadata with the server after TLS handshake.
2947
2969
  #
2948
2970
  # @yield [response, operation] Access the result along with the RPC operation
2949
2971
  # @yieldparam response [::Google::Cloud::AlloyDB::V1beta::GenerateClientCertificateResponse]
@@ -3643,9 +3665,9 @@ module Google
3643
3665
  # end
3644
3666
  #
3645
3667
  # @!attribute [rw] endpoint
3646
- # The hostname or hostname:port of the service endpoint.
3647
- # Defaults to `"alloydb.googleapis.com"`.
3648
- # @return [::String]
3668
+ # A custom service endpoint, as a hostname or hostname:port. The default is
3669
+ # nil, indicating to use the default endpoint in the current universe domain.
3670
+ # @return [::String,nil]
3649
3671
  # @!attribute [rw] credentials
3650
3672
  # Credentials to send with calls. You may provide any of the following types:
3651
3673
  # * (`String`) The path to a service account key file in JSON format
@@ -3691,13 +3713,20 @@ module Google
3691
3713
  # @!attribute [rw] quota_project
3692
3714
  # A separate project against which to charge quota.
3693
3715
  # @return [::String]
3716
+ # @!attribute [rw] universe_domain
3717
+ # The universe domain within which to make requests. This determines the
3718
+ # default endpoint URL. The default value of nil uses the environment
3719
+ # universe (usually the default "googleapis.com" universe).
3720
+ # @return [::String,nil]
3694
3721
  #
3695
3722
  class Configuration
3696
3723
  extend ::Gapic::Config
3697
3724
 
3725
+ # @private
3726
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
3698
3727
  DEFAULT_ENDPOINT = "alloydb.googleapis.com"
3699
3728
 
3700
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3729
+ config_attr :endpoint, nil, ::String, nil
3701
3730
  config_attr :credentials, nil do |value|
3702
3731
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3703
3732
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -3712,6 +3741,7 @@ module Google
3712
3741
  config_attr :metadata, nil, ::Hash, nil
3713
3742
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3714
3743
  config_attr :quota_project, nil, ::String, nil
3744
+ config_attr :universe_domain, nil, ::String, nil
3715
3745
 
3716
3746
  # @private
3717
3747
  def initialize parent_config = nil
data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module AlloyDBAdmin
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "alloydb.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -90,8 +102,10 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.endpoint,
105
+ credentials: credentials,
106
+ endpoint: @config.endpoint,
107
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
108
+ universe_domain: @config.universe_domain,
95
109
  channel_args: @config.channel_args,
96
110
  interceptors: @config.interceptors,
97
111
  channel_pool_config: @config.channel_pool
@@ -613,9 +627,9 @@ module Google
613
627
  # end
614
628
  #
615
629
  # @!attribute [rw] endpoint
616
- # The hostname or hostname:port of the service endpoint.
617
- # Defaults to `"alloydb.googleapis.com"`.
618
- # @return [::String]
630
+ # A custom service endpoint, as a hostname or hostname:port. The default is
631
+ # nil, indicating to use the default endpoint in the current universe domain.
632
+ # @return [::String,nil]
619
633
  # @!attribute [rw] credentials
620
634
  # Credentials to send with calls. You may provide any of the following types:
621
635
  # * (`String`) The path to a service account key file in JSON format
@@ -661,13 +675,20 @@ module Google
661
675
  # @!attribute [rw] quota_project
662
676
  # A separate project against which to charge quota.
663
677
  # @return [::String]
678
+ # @!attribute [rw] universe_domain
679
+ # The universe domain within which to make requests. This determines the
680
+ # default endpoint URL. The default value of nil uses the environment
681
+ # universe (usually the default "googleapis.com" universe).
682
+ # @return [::String,nil]
664
683
  #
665
684
  class Configuration
666
685
  extend ::Gapic::Config
667
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
668
689
  DEFAULT_ENDPOINT = "alloydb.googleapis.com"
669
690
 
670
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
671
692
  config_attr :credentials, nil do |value|
672
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
673
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -682,6 +703,7 @@ module Google
682
703
  config_attr :metadata, nil, ::Hash, nil
683
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
684
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
685
707
 
686
708
  # @private
687
709
  def initialize parent_config = nil
data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # Service describing handlers for resources
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "alloydb.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -151,6 +154,15 @@ module Google
151
154
  @config
152
155
  end
153
156
 
157
+ ##
158
+ # The effective universe domain
159
+ #
160
+ # @return [String]
161
+ #
162
+ def universe_domain
163
+ @alloy_db_admin_stub.universe_domain
164
+ end
165
+
154
166
  ##
155
167
  # Create a new AlloyDBAdmin REST client object.
156
168
  #
@@ -178,8 +190,9 @@ module Google
178
190
  credentials = @config.credentials
179
191
  # Use self-signed JWT if the endpoint is unchanged from default,
180
192
  # but only if the default endpoint does not have a region prefix.
181
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
182
- !@config.endpoint.split(".").first.include?("-")
193
+ enable_self_signed_jwt = @config.endpoint.nil? ||
194
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
195
+ !@config.endpoint.split(".").first.include?("-"))
183
196
  credentials ||= Credentials.default scope: @config.scope,
184
197
  enable_self_signed_jwt: enable_self_signed_jwt
185
198
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -193,12 +206,14 @@ module Google
193
206
  config.credentials = credentials
194
207
  config.quota_project = @quota_project_id
195
208
  config.endpoint = @config.endpoint
209
+ config.universe_domain = @config.universe_domain
196
210
  end
197
211
 
198
212
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
199
213
  config.credentials = credentials
200
214
  config.quota_project = @quota_project_id
201
215
  config.endpoint = @config.endpoint
216
+ config.universe_domain = @config.universe_domain
202
217
  config.bindings_override = @config.bindings_override
203
218
  end
204
219
 
@@ -206,9 +221,15 @@ module Google
206
221
  config.credentials = credentials
207
222
  config.quota_project = @quota_project_id
208
223
  config.endpoint = @config.endpoint
224
+ config.universe_domain = @config.universe_domain
209
225
  end
210
226
 
211
- @alloy_db_admin_stub = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
227
+ @alloy_db_admin_stub = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::ServiceStub.new(
228
+ endpoint: @config.endpoint,
229
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
230
+ universe_domain: @config.universe_domain,
231
+ credentials: credentials
232
+ )
212
233
  end
213
234
 
214
235
  ##
@@ -2717,10 +2738,10 @@ module Google
2717
2738
 
2718
2739
  ##
2719
2740
  # Generate a client certificate signed by a Cluster CA.
2720
- # The sole purpose of this endpoint is to support the Auth Proxy client and
2721
- # the endpoint's behavior is subject to change without notice, so do not rely
2722
- # on its behavior remaining constant. Future changes will not break the Auth
2723
- # Proxy client.
2741
+ # The sole purpose of this endpoint is to support AlloyDB connectors and the
2742
+ # Auth Proxy client. The endpoint's behavior is subject to change without
2743
+ # notice, so do not rely on its behavior remaining constant. Future changes
2744
+ # will not break AlloyDB connectors or the Auth Proxy client.
2724
2745
  #
2725
2746
  # @overload generate_client_certificate(request, options = nil)
2726
2747
  # Pass arguments to `generate_client_certificate` via a request object, either of type
@@ -2732,7 +2753,7 @@ module Google
2732
2753
  # @param options [::Gapic::CallOptions, ::Hash]
2733
2754
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2734
2755
  #
2735
- # @overload generate_client_certificate(parent: nil, request_id: nil, pem_csr: nil, cert_duration: nil, public_key: nil)
2756
+ # @overload generate_client_certificate(parent: nil, request_id: nil, pem_csr: nil, cert_duration: nil, public_key: nil, use_metadata_exchange: nil)
2736
2757
  # Pass arguments to `generate_client_certificate` via keyword arguments. Note that at
2737
2758
  # least one keyword argument is required. To specify no parameters, or to keep all
2738
2759
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2764,6 +2785,10 @@ module Google
2764
2785
  # default duration.
2765
2786
  # @param public_key [::String]
2766
2787
  # Optional. The public key from the client.
2788
+ # @param use_metadata_exchange [::Boolean]
2789
+ # Optional. An optional hint to the endpoint to generate a client
2790
+ # ceritificate that can be used by AlloyDB connectors to exchange additional
2791
+ # metadata with the server after TLS handshake.
2767
2792
  # @yield [result, operation] Access the result along with the TransportOperation object
2768
2793
  # @yieldparam result [::Google::Cloud::AlloyDB::V1beta::GenerateClientCertificateResponse]
2769
2794
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -3413,9 +3438,9 @@ module Google
3413
3438
  # end
3414
3439
  #
3415
3440
  # @!attribute [rw] endpoint
3416
- # The hostname or hostname:port of the service endpoint.
3417
- # Defaults to `"alloydb.googleapis.com"`.
3418
- # @return [::String]
3441
+ # A custom service endpoint, as a hostname or hostname:port. The default is
3442
+ # nil, indicating to use the default endpoint in the current universe domain.
3443
+ # @return [::String,nil]
3419
3444
  # @!attribute [rw] credentials
3420
3445
  # Credentials to send with calls. You may provide any of the following types:
3421
3446
  # * (`String`) The path to a service account key file in JSON format
@@ -3452,13 +3477,20 @@ module Google
3452
3477
  # @!attribute [rw] quota_project
3453
3478
  # A separate project against which to charge quota.
3454
3479
  # @return [::String]
3480
+ # @!attribute [rw] universe_domain
3481
+ # The universe domain within which to make requests. This determines the
3482
+ # default endpoint URL. The default value of nil uses the environment
3483
+ # universe (usually the default "googleapis.com" universe).
3484
+ # @return [::String,nil]
3455
3485
  #
3456
3486
  class Configuration
3457
3487
  extend ::Gapic::Config
3458
3488
 
3489
+ # @private
3490
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
3459
3491
  DEFAULT_ENDPOINT = "alloydb.googleapis.com"
3460
3492
 
3461
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3493
+ config_attr :endpoint, nil, ::String, nil
3462
3494
  config_attr :credentials, nil do |value|
3463
3495
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3464
3496
  allowed.any? { |klass| klass === value }
@@ -3470,6 +3502,7 @@ module Google
3470
3502
  config_attr :metadata, nil, ::Hash, nil
3471
3503
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3472
3504
  config_attr :quota_project, nil, ::String, nil
3505
+ config_attr :universe_domain, nil, ::String, nil
3473
3506
 
3474
3507
  # @private
3475
3508
  # Overrides for http bindings for the RPCs of this service