google-cloud-metastore-v1 0.10.0 → 0.12.0

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: ac4a8bea604f120099cf58e0d1dfb3301a94937eb0b275125e0c3376480eaa4c
4
- data.tar.gz: 1ccc1f5c20c36939a480a79138c8f03b70e3367f422936f51259d07b8a2922e6
3
+ metadata.gz: 9e4105c006b40ed222cdda09368d79e1f358d169d239be7d4958285a0ce4965d
4
+ data.tar.gz: 7968cffc74ad4122610bfce845c0cfbcb3052f0a85c6c51fb0728a6a97ec472d
5
5
  SHA512:
6
- metadata.gz: 442fc5a493e527fb962cd07db1bc4d43e43c05879c15e406d8d3613eb1007049848d1c8ce3ab9dbf922b6b7eae8bfcdc148bd6a2a4f84403ab5585c4c7e180a3
7
- data.tar.gz: 595e85edb85d3e4437284f93050f9e4a58c29dea56db56146500d624bfb1d7cee8bc680d010fa3b2484a63a6d94c61b2adb3485cc2227e82fa4fc863b9578f44
6
+ metadata.gz: 484acd3be11608eecd25733bf7a5664703e318307a5d43f24df44d3e9bd79930e2767e74b6dda61279cf11a532599b9dbbc090198fdc9c4d00dc4eedbc69b40a
7
+ data.tar.gz: a121caab8d71193edbef4d8b23abf3adae3b0065617637c6ca001fb6e8d5de88adf9b737d3ad1433cd3342c02db2922184c664fc7299865c1a170cf0a713369a
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-metastore-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-metastore-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 METASTORE_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/metastore/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::Metastore::V1::DataprocMetastore::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-metastore-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-metastore-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-metastore-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Metastore::V1::DataprocMetastore::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `METASTORE_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `METASTORE_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/metastore/v1"
77
-
78
- ENV["METASTORE_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Metastore::V1::DataprocMetastore::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/metastore/v1"
90
58
 
91
59
  client = ::Google::Cloud::Metastore::V1::DataprocMetastore::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/metastore/v1"
100
68
 
101
69
  ::Google::Cloud::Metastore::V1::DataprocMetastore::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::Metastore::V1::DataprocMetastore::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-metastore-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/metastore/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-metastore-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::Metastore::V1::DataprocMetastore::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).
@@ -48,6 +48,9 @@ module Google
48
48
  # `/projects/{project_number}/locations/{location_id}/services/{service_id}`.
49
49
  #
50
50
  class Client
51
+ # @private
52
+ DEFAULT_ENDPOINT_TEMPLATE = "metastore.$UNIVERSE_DOMAIN$"
53
+
51
54
  include Paths
52
55
 
53
56
  # @private
@@ -131,6 +134,15 @@ module Google
131
134
  @config
132
135
  end
133
136
 
137
+ ##
138
+ # The effective universe domain
139
+ #
140
+ # @return [String]
141
+ #
142
+ def universe_domain
143
+ @dataproc_metastore_stub.universe_domain
144
+ end
145
+
134
146
  ##
135
147
  # Create a new DataprocMetastore client object.
136
148
  #
@@ -164,8 +176,9 @@ module Google
164
176
  credentials = @config.credentials
165
177
  # Use self-signed JWT if the endpoint is unchanged from default,
166
178
  # but only if the default endpoint does not have a region prefix.
167
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
168
- !@config.endpoint.split(".").first.include?("-")
179
+ enable_self_signed_jwt = @config.endpoint.nil? ||
180
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
181
+ !@config.endpoint.split(".").first.include?("-"))
169
182
  credentials ||= Credentials.default scope: @config.scope,
170
183
  enable_self_signed_jwt: enable_self_signed_jwt
171
184
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -178,24 +191,29 @@ module Google
178
191
  config.credentials = credentials
179
192
  config.quota_project = @quota_project_id
180
193
  config.endpoint = @config.endpoint
194
+ config.universe_domain = @config.universe_domain
181
195
  end
182
196
 
183
197
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
184
198
  config.credentials = credentials
185
199
  config.quota_project = @quota_project_id
186
200
  config.endpoint = @config.endpoint
201
+ config.universe_domain = @config.universe_domain
187
202
  end
188
203
 
189
204
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
190
205
  config.credentials = credentials
191
206
  config.quota_project = @quota_project_id
192
207
  config.endpoint = @config.endpoint
208
+ config.universe_domain = @config.universe_domain
193
209
  end
194
210
 
195
211
  @dataproc_metastore_stub = ::Gapic::ServiceStub.new(
196
212
  ::Google::Cloud::Metastore::V1::DataprocMetastore::Stub,
197
- credentials: credentials,
198
- endpoint: @config.endpoint,
213
+ credentials: credentials,
214
+ endpoint: @config.endpoint,
215
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
216
+ universe_domain: @config.universe_domain,
199
217
  channel_args: @config.channel_args,
200
218
  interceptors: @config.interceptors,
201
219
  channel_pool_config: @config.channel_pool
@@ -2209,9 +2227,9 @@ module Google
2209
2227
  # end
2210
2228
  #
2211
2229
  # @!attribute [rw] endpoint
2212
- # The hostname or hostname:port of the service endpoint.
2213
- # Defaults to `"metastore.googleapis.com"`.
2214
- # @return [::String]
2230
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2231
+ # nil, indicating to use the default endpoint in the current universe domain.
2232
+ # @return [::String,nil]
2215
2233
  # @!attribute [rw] credentials
2216
2234
  # Credentials to send with calls. You may provide any of the following types:
2217
2235
  # * (`String`) The path to a service account key file in JSON format
@@ -2257,13 +2275,20 @@ module Google
2257
2275
  # @!attribute [rw] quota_project
2258
2276
  # A separate project against which to charge quota.
2259
2277
  # @return [::String]
2278
+ # @!attribute [rw] universe_domain
2279
+ # The universe domain within which to make requests. This determines the
2280
+ # default endpoint URL. The default value of nil uses the environment
2281
+ # universe (usually the default "googleapis.com" universe).
2282
+ # @return [::String,nil]
2260
2283
  #
2261
2284
  class Configuration
2262
2285
  extend ::Gapic::Config
2263
2286
 
2287
+ # @private
2288
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2264
2289
  DEFAULT_ENDPOINT = "metastore.googleapis.com"
2265
2290
 
2266
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2291
+ config_attr :endpoint, nil, ::String, nil
2267
2292
  config_attr :credentials, nil do |value|
2268
2293
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2269
2294
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -2278,6 +2303,7 @@ module Google
2278
2303
  config_attr :metadata, nil, ::Hash, nil
2279
2304
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2280
2305
  config_attr :quota_project, nil, ::String, nil
2306
+ config_attr :universe_domain, nil, ::String, nil
2281
2307
 
2282
2308
  # @private
2283
2309
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module DataprocMetastore
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "metastore.$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 `"metastore.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 = "metastore.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
@@ -50,6 +50,9 @@ module Google
50
50
  # `/projects/{project_number}/locations/{location_id}/services/{service_id}`.
51
51
  #
52
52
  class Client
53
+ # @private
54
+ DEFAULT_ENDPOINT_TEMPLATE = "metastore.$UNIVERSE_DOMAIN$"
55
+
53
56
  include Paths
54
57
 
55
58
  # @private
@@ -133,6 +136,15 @@ module Google
133
136
  @config
134
137
  end
135
138
 
139
+ ##
140
+ # The effective universe domain
141
+ #
142
+ # @return [String]
143
+ #
144
+ def universe_domain
145
+ @dataproc_metastore_stub.universe_domain
146
+ end
147
+
136
148
  ##
137
149
  # Create a new DataprocMetastore REST client object.
138
150
  #
@@ -160,8 +172,9 @@ module Google
160
172
  credentials = @config.credentials
161
173
  # Use self-signed JWT if the endpoint is unchanged from default,
162
174
  # but only if the default endpoint does not have a region prefix.
163
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
164
- !@config.endpoint.split(".").first.include?("-")
175
+ enable_self_signed_jwt = @config.endpoint.nil? ||
176
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
177
+ !@config.endpoint.split(".").first.include?("-"))
165
178
  credentials ||= Credentials.default scope: @config.scope,
166
179
  enable_self_signed_jwt: enable_self_signed_jwt
167
180
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -175,12 +188,14 @@ module Google
175
188
  config.credentials = credentials
176
189
  config.quota_project = @quota_project_id
177
190
  config.endpoint = @config.endpoint
191
+ config.universe_domain = @config.universe_domain
178
192
  end
179
193
 
180
194
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
181
195
  config.credentials = credentials
182
196
  config.quota_project = @quota_project_id
183
197
  config.endpoint = @config.endpoint
198
+ config.universe_domain = @config.universe_domain
184
199
  config.bindings_override = @config.bindings_override
185
200
  end
186
201
 
@@ -188,10 +203,16 @@ module Google
188
203
  config.credentials = credentials
189
204
  config.quota_project = @quota_project_id
190
205
  config.endpoint = @config.endpoint
206
+ config.universe_domain = @config.universe_domain
191
207
  config.bindings_override = @config.bindings_override
192
208
  end
193
209
 
194
- @dataproc_metastore_stub = ::Google::Cloud::Metastore::V1::DataprocMetastore::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
210
+ @dataproc_metastore_stub = ::Google::Cloud::Metastore::V1::DataprocMetastore::Rest::ServiceStub.new(
211
+ endpoint: @config.endpoint,
212
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
213
+ universe_domain: @config.universe_domain,
214
+ credentials: credentials
215
+ )
195
216
  end
196
217
 
197
218
  ##
@@ -2072,9 +2093,9 @@ module Google
2072
2093
  # end
2073
2094
  #
2074
2095
  # @!attribute [rw] endpoint
2075
- # The hostname or hostname:port of the service endpoint.
2076
- # Defaults to `"metastore.googleapis.com"`.
2077
- # @return [::String]
2096
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2097
+ # nil, indicating to use the default endpoint in the current universe domain.
2098
+ # @return [::String,nil]
2078
2099
  # @!attribute [rw] credentials
2079
2100
  # Credentials to send with calls. You may provide any of the following types:
2080
2101
  # * (`String`) The path to a service account key file in JSON format
@@ -2111,13 +2132,20 @@ module Google
2111
2132
  # @!attribute [rw] quota_project
2112
2133
  # A separate project against which to charge quota.
2113
2134
  # @return [::String]
2135
+ # @!attribute [rw] universe_domain
2136
+ # The universe domain within which to make requests. This determines the
2137
+ # default endpoint URL. The default value of nil uses the environment
2138
+ # universe (usually the default "googleapis.com" universe).
2139
+ # @return [::String,nil]
2114
2140
  #
2115
2141
  class Configuration
2116
2142
  extend ::Gapic::Config
2117
2143
 
2144
+ # @private
2145
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2118
2146
  DEFAULT_ENDPOINT = "metastore.googleapis.com"
2119
2147
 
2120
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2148
+ config_attr :endpoint, nil, ::String, nil
2121
2149
  config_attr :credentials, nil do |value|
2122
2150
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2123
2151
  allowed.any? { |klass| klass === value }
@@ -2129,6 +2157,7 @@ module Google
2129
2157
  config_attr :metadata, nil, ::Hash, nil
2130
2158
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2131
2159
  config_attr :quota_project, nil, ::String, nil
2160
+ config_attr :universe_domain, nil, ::String, nil
2132
2161
 
2133
2162
  # @private
2134
2163
  # Overrides for http bindings for the RPCs of this service
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "metastore.$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
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -478,9 +492,9 @@ module Google
478
492
  # end
479
493
  #
480
494
  # @!attribute [rw] endpoint
481
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"metastore.googleapis.com"`.
483
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
484
498
  # @!attribute [rw] credentials
485
499
  # Credentials to send with calls. You may provide any of the following types:
486
500
  # * (`String`) The path to a service account key file in JSON format
@@ -517,13 +531,20 @@ module Google
517
531
  # @!attribute [rw] quota_project
518
532
  # A separate project against which to charge quota.
519
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
520
539
  #
521
540
  class Configuration
522
541
  extend ::Gapic::Config
523
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
524
545
  DEFAULT_ENDPOINT = "metastore.googleapis.com"
525
546
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
527
548
  config_attr :credentials, nil do |value|
528
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
529
550
  allowed.any? { |klass| klass === value }
@@ -535,6 +556,7 @@ module Google
535
556
  config_attr :metadata, nil, ::Hash, nil
536
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
537
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
538
560
 
539
561
  # @private
540
562
  def initialize parent_config = nil
@@ -617,12 +639,15 @@ module Google
617
639
  # Service stub contains baseline method implementations
618
640
  # including transcoding, making the REST call, and deserialing the response.
619
641
  class OperationsServiceStub
620
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
621
643
  # These require statements are intentionally placed here to initialize
622
644
  # the REST modules only when it's required.
623
645
  require "gapic/rest"
624
646
 
625
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
626
651
  end
627
652
 
628
653
  ##