google-cloud-retail-v2 0.17.0 → 0.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/retail/v2/catalog_service/client.rb +32 -8
  4. data/lib/google/cloud/retail/v2/catalog_service/rest/client.rb +34 -7
  5. data/lib/google/cloud/retail/v2/catalog_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/retail/v2/completion_service/client.rb +33 -8
  7. data/lib/google/cloud/retail/v2/completion_service/operations.rb +28 -6
  8. data/lib/google/cloud/retail/v2/completion_service/rest/client.rb +35 -7
  9. data/lib/google/cloud/retail/v2/completion_service/rest/operations.rb +33 -8
  10. data/lib/google/cloud/retail/v2/completion_service/rest/service_stub.rb +14 -2
  11. data/lib/google/cloud/retail/v2/control_service/client.rb +32 -8
  12. data/lib/google/cloud/retail/v2/control_service/rest/client.rb +34 -7
  13. data/lib/google/cloud/retail/v2/control_service/rest/service_stub.rb +14 -2
  14. data/lib/google/cloud/retail/v2/model_service/client.rb +33 -8
  15. data/lib/google/cloud/retail/v2/model_service/operations.rb +28 -6
  16. data/lib/google/cloud/retail/v2/model_service/rest/client.rb +35 -7
  17. data/lib/google/cloud/retail/v2/model_service/rest/operations.rb +33 -8
  18. data/lib/google/cloud/retail/v2/model_service/rest/service_stub.rb +14 -2
  19. data/lib/google/cloud/retail/v2/prediction_service/client.rb +32 -8
  20. data/lib/google/cloud/retail/v2/prediction_service/rest/client.rb +34 -7
  21. data/lib/google/cloud/retail/v2/prediction_service/rest/service_stub.rb +14 -2
  22. data/lib/google/cloud/retail/v2/product_service/client.rb +33 -8
  23. data/lib/google/cloud/retail/v2/product_service/operations.rb +28 -6
  24. data/lib/google/cloud/retail/v2/product_service/rest/client.rb +35 -7
  25. data/lib/google/cloud/retail/v2/product_service/rest/operations.rb +33 -8
  26. data/lib/google/cloud/retail/v2/product_service/rest/service_stub.rb +14 -2
  27. data/lib/google/cloud/retail/v2/search_service/client.rb +32 -8
  28. data/lib/google/cloud/retail/v2/search_service/rest/client.rb +34 -7
  29. data/lib/google/cloud/retail/v2/search_service/rest/service_stub.rb +14 -2
  30. data/lib/google/cloud/retail/v2/serving_config_service/client.rb +32 -8
  31. data/lib/google/cloud/retail/v2/serving_config_service/rest/client.rb +34 -7
  32. data/lib/google/cloud/retail/v2/serving_config_service/rest/service_stub.rb +14 -2
  33. data/lib/google/cloud/retail/v2/user_event_service/client.rb +33 -8
  34. data/lib/google/cloud/retail/v2/user_event_service/operations.rb +28 -6
  35. data/lib/google/cloud/retail/v2/user_event_service/rest/client.rb +35 -7
  36. data/lib/google/cloud/retail/v2/user_event_service/rest/operations.rb +33 -8
  37. data/lib/google/cloud/retail/v2/user_event_service/rest/service_stub.rb +14 -2
  38. data/lib/google/cloud/retail/v2/version.rb +1 -1
  39. data/proto_docs/google/api/client.rb +14 -0
  40. data/proto_docs/google/cloud/retail/v2/common.rb +2 -0
  41. data/proto_docs/google/cloud/retail/v2/import_config.rb +2 -0
  42. data/proto_docs/google/cloud/retail/v2/prediction_service.rb +1 -0
  43. data/proto_docs/google/cloud/retail/v2/product.rb +1 -0
  44. data/proto_docs/google/cloud/retail/v2/search_service.rb +1 -0
  45. metadata +7 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c211723334dc32507a15c553160e52732b9dee5f92878a89541eb4316bfd714d
4
- data.tar.gz: f6d10e7a1efc8d2c72e40adcf5b2290825e37f2d8f7ad39a996d318014e748dd
3
+ metadata.gz: 2d832bbbddc40079dd5e42f092c498c0940f0175f932bf56f3625b4d21766257
4
+ data.tar.gz: e7ba9f26e6b6d784f640ad1a9e736ac6c15f0ec501ff3196832881f9b19a9d4d
5
5
  SHA512:
6
- metadata.gz: 6bce0c6e330533283a462f1ea4cc07d6ec1a359654a9a03db2f59607adb2cb72a308508384f367e9d08b1b2cbd30c623841c06e572bc4939c543c5d3e41fa2b6
7
- data.tar.gz: a98c098417c105c885a7942bcb8d1cc26224a3ebfa1bb02234e18cafbfdf7e650f7a24e49c35cba89b009644cbb7d14d814c80dc1d1d0c1526d4f417e2ac1718
6
+ metadata.gz: 3edf8a4ae00c2d77acb58bb890999506ec2b9a93016f0c71d798d85483e607baceac891c6887bc344d2d617b835f89b96252fe9f7667cf96bf54f604f18d6064
7
+ data.tar.gz: a9621fc720251a73b578ea69cedd92d448f50b483fde5182820e32e2911adfbf6feea93c624b55f3fc996f29e936136a598706f887698dc363d991408261fdca
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-retail-v2 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-retail-v2 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 RETAIL_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/retail/v2"
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::Retail::V2::CatalogService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-retail-v2 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-retail-v2 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-retail-v2
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Retail::V2::CatalogService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `RETAIL_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `RETAIL_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/retail/v2"
77
-
78
- ENV["RETAIL_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Retail::V2::CatalogService::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/retail/v2"
90
58
 
91
59
  client = ::Google::Cloud::Retail::V2::CatalogService::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/retail/v2"
100
68
 
101
69
  ::Google::Cloud::Retail::V2::CatalogService::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::Retail::V2::CatalogService::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-retail-v2
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/retail/v2"
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-retail-v2.
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::Retail::V2::CatalogService::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).
@@ -31,6 +31,9 @@ module Google
31
31
  # Service for managing catalog configuration.
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "retail.$UNIVERSE_DOMAIN$"
36
+
34
37
  include Paths
35
38
 
36
39
  # @private
@@ -96,6 +99,15 @@ module Google
96
99
  @config
97
100
  end
98
101
 
102
+ ##
103
+ # The effective universe domain
104
+ #
105
+ # @return [String]
106
+ #
107
+ def universe_domain
108
+ @catalog_service_stub.universe_domain
109
+ end
110
+
99
111
  ##
100
112
  # Create a new CatalogService client object.
101
113
  #
@@ -129,8 +141,9 @@ module Google
129
141
  credentials = @config.credentials
130
142
  # Use self-signed JWT if the endpoint is unchanged from default,
131
143
  # but only if the default endpoint does not have a region prefix.
132
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
133
- !@config.endpoint.split(".").first.include?("-")
144
+ enable_self_signed_jwt = @config.endpoint.nil? ||
145
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
146
+ !@config.endpoint.split(".").first.include?("-"))
134
147
  credentials ||= Credentials.default scope: @config.scope,
135
148
  enable_self_signed_jwt: enable_self_signed_jwt
136
149
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -143,12 +156,15 @@ module Google
143
156
  config.credentials = credentials
144
157
  config.quota_project = @quota_project_id
145
158
  config.endpoint = @config.endpoint
159
+ config.universe_domain = @config.universe_domain
146
160
  end
147
161
 
148
162
  @catalog_service_stub = ::Gapic::ServiceStub.new(
149
163
  ::Google::Cloud::Retail::V2::CatalogService::Stub,
150
- credentials: credentials,
151
- endpoint: @config.endpoint,
164
+ credentials: credentials,
165
+ endpoint: @config.endpoint,
166
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
167
+ universe_domain: @config.universe_domain,
152
168
  channel_args: @config.channel_args,
153
169
  interceptors: @config.interceptors,
154
170
  channel_pool_config: @config.channel_pool
@@ -1300,9 +1316,9 @@ module Google
1300
1316
  # end
1301
1317
  #
1302
1318
  # @!attribute [rw] endpoint
1303
- # The hostname or hostname:port of the service endpoint.
1304
- # Defaults to `"retail.googleapis.com"`.
1305
- # @return [::String]
1319
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1320
+ # nil, indicating to use the default endpoint in the current universe domain.
1321
+ # @return [::String,nil]
1306
1322
  # @!attribute [rw] credentials
1307
1323
  # Credentials to send with calls. You may provide any of the following types:
1308
1324
  # * (`String`) The path to a service account key file in JSON format
@@ -1348,13 +1364,20 @@ module Google
1348
1364
  # @!attribute [rw] quota_project
1349
1365
  # A separate project against which to charge quota.
1350
1366
  # @return [::String]
1367
+ # @!attribute [rw] universe_domain
1368
+ # The universe domain within which to make requests. This determines the
1369
+ # default endpoint URL. The default value of nil uses the environment
1370
+ # universe (usually the default "googleapis.com" universe).
1371
+ # @return [::String,nil]
1351
1372
  #
1352
1373
  class Configuration
1353
1374
  extend ::Gapic::Config
1354
1375
 
1376
+ # @private
1377
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1355
1378
  DEFAULT_ENDPOINT = "retail.googleapis.com"
1356
1379
 
1357
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1380
+ config_attr :endpoint, nil, ::String, nil
1358
1381
  config_attr :credentials, nil do |value|
1359
1382
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1360
1383
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1369,6 +1392,7 @@ module Google
1369
1392
  config_attr :metadata, nil, ::Hash, nil
1370
1393
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1371
1394
  config_attr :quota_project, nil, ::String, nil
1395
+ config_attr :universe_domain, nil, ::String, nil
1372
1396
 
1373
1397
  # @private
1374
1398
  def initialize parent_config = nil
@@ -33,6 +33,9 @@ module Google
33
33
  # Service for managing catalog configuration.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "retail.$UNIVERSE_DOMAIN$"
38
+
36
39
  include Paths
37
40
 
38
41
  # @private
@@ -98,6 +101,15 @@ module Google
98
101
  @config
99
102
  end
100
103
 
104
+ ##
105
+ # The effective universe domain
106
+ #
107
+ # @return [String]
108
+ #
109
+ def universe_domain
110
+ @catalog_service_stub.universe_domain
111
+ end
112
+
101
113
  ##
102
114
  # Create a new CatalogService REST client object.
103
115
  #
@@ -125,8 +137,9 @@ module Google
125
137
  credentials = @config.credentials
126
138
  # Use self-signed JWT if the endpoint is unchanged from default,
127
139
  # but only if the default endpoint does not have a region prefix.
128
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
129
- !@config.endpoint.split(".").first.include?("-")
140
+ enable_self_signed_jwt = @config.endpoint.nil? ||
141
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
+ !@config.endpoint.split(".").first.include?("-"))
130
143
  credentials ||= Credentials.default scope: @config.scope,
131
144
  enable_self_signed_jwt: enable_self_signed_jwt
132
145
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -140,9 +153,15 @@ module Google
140
153
  config.credentials = credentials
141
154
  config.quota_project = @quota_project_id
142
155
  config.endpoint = @config.endpoint
156
+ config.universe_domain = @config.universe_domain
143
157
  end
144
158
 
145
- @catalog_service_stub = ::Google::Cloud::Retail::V2::CatalogService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
159
+ @catalog_service_stub = ::Google::Cloud::Retail::V2::CatalogService::Rest::ServiceStub.new(
160
+ endpoint: @config.endpoint,
161
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
162
+ universe_domain: @config.universe_domain,
163
+ credentials: credentials
164
+ )
146
165
  end
147
166
 
148
167
  ##
@@ -1213,9 +1232,9 @@ module Google
1213
1232
  # end
1214
1233
  #
1215
1234
  # @!attribute [rw] endpoint
1216
- # The hostname or hostname:port of the service endpoint.
1217
- # Defaults to `"retail.googleapis.com"`.
1218
- # @return [::String]
1235
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1236
+ # nil, indicating to use the default endpoint in the current universe domain.
1237
+ # @return [::String,nil]
1219
1238
  # @!attribute [rw] credentials
1220
1239
  # Credentials to send with calls. You may provide any of the following types:
1221
1240
  # * (`String`) The path to a service account key file in JSON format
@@ -1252,13 +1271,20 @@ module Google
1252
1271
  # @!attribute [rw] quota_project
1253
1272
  # A separate project against which to charge quota.
1254
1273
  # @return [::String]
1274
+ # @!attribute [rw] universe_domain
1275
+ # The universe domain within which to make requests. This determines the
1276
+ # default endpoint URL. The default value of nil uses the environment
1277
+ # universe (usually the default "googleapis.com" universe).
1278
+ # @return [::String,nil]
1255
1279
  #
1256
1280
  class Configuration
1257
1281
  extend ::Gapic::Config
1258
1282
 
1283
+ # @private
1284
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1259
1285
  DEFAULT_ENDPOINT = "retail.googleapis.com"
1260
1286
 
1261
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1287
+ config_attr :endpoint, nil, ::String, nil
1262
1288
  config_attr :credentials, nil do |value|
1263
1289
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1264
1290
  allowed.any? { |klass| klass === value }
@@ -1270,6 +1296,7 @@ module Google
1270
1296
  config_attr :metadata, nil, ::Hash, nil
1271
1297
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1272
1298
  config_attr :quota_project, nil, ::String, nil
1299
+ config_attr :universe_domain, nil, ::String, nil
1273
1300
 
1274
1301
  # @private
1275
1302
  def initialize parent_config = nil
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the list_catalogs REST call
45
57
  #
@@ -34,6 +34,9 @@ module Google
34
34
  # Enable Retail Search on Cloud Console before using this feature.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "retail.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -99,6 +102,15 @@ module Google
99
102
  @config
100
103
  end
101
104
 
105
+ ##
106
+ # The effective universe domain
107
+ #
108
+ # @return [String]
109
+ #
110
+ def universe_domain
111
+ @completion_service_stub.universe_domain
112
+ end
113
+
102
114
  ##
103
115
  # Create a new CompletionService client object.
104
116
  #
@@ -132,8 +144,9 @@ module Google
132
144
  credentials = @config.credentials
133
145
  # Use self-signed JWT if the endpoint is unchanged from default,
134
146
  # but only if the default endpoint does not have a region prefix.
135
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
136
- !@config.endpoint.split(".").first.include?("-")
147
+ enable_self_signed_jwt = @config.endpoint.nil? ||
148
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
149
+ !@config.endpoint.split(".").first.include?("-"))
137
150
  credentials ||= Credentials.default scope: @config.scope,
138
151
  enable_self_signed_jwt: enable_self_signed_jwt
139
152
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -146,18 +159,22 @@ module Google
146
159
  config.credentials = credentials
147
160
  config.quota_project = @quota_project_id
148
161
  config.endpoint = @config.endpoint
162
+ config.universe_domain = @config.universe_domain
149
163
  end
150
164
 
151
165
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
152
166
  config.credentials = credentials
153
167
  config.quota_project = @quota_project_id
154
168
  config.endpoint = @config.endpoint
169
+ config.universe_domain = @config.universe_domain
155
170
  end
156
171
 
157
172
  @completion_service_stub = ::Gapic::ServiceStub.new(
158
173
  ::Google::Cloud::Retail::V2::CompletionService::Stub,
159
- credentials: credentials,
160
- endpoint: @config.endpoint,
174
+ credentials: credentials,
175
+ endpoint: @config.endpoint,
176
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
177
+ universe_domain: @config.universe_domain,
161
178
  channel_args: @config.channel_args,
162
179
  interceptors: @config.interceptors,
163
180
  channel_pool_config: @config.channel_pool
@@ -479,9 +496,9 @@ module Google
479
496
  # end
480
497
  #
481
498
  # @!attribute [rw] endpoint
482
- # The hostname or hostname:port of the service endpoint.
483
- # Defaults to `"retail.googleapis.com"`.
484
- # @return [::String]
499
+ # A custom service endpoint, as a hostname or hostname:port. The default is
500
+ # nil, indicating to use the default endpoint in the current universe domain.
501
+ # @return [::String,nil]
485
502
  # @!attribute [rw] credentials
486
503
  # Credentials to send with calls. You may provide any of the following types:
487
504
  # * (`String`) The path to a service account key file in JSON format
@@ -527,13 +544,20 @@ module Google
527
544
  # @!attribute [rw] quota_project
528
545
  # A separate project against which to charge quota.
529
546
  # @return [::String]
547
+ # @!attribute [rw] universe_domain
548
+ # The universe domain within which to make requests. This determines the
549
+ # default endpoint URL. The default value of nil uses the environment
550
+ # universe (usually the default "googleapis.com" universe).
551
+ # @return [::String,nil]
530
552
  #
531
553
  class Configuration
532
554
  extend ::Gapic::Config
533
555
 
556
+ # @private
557
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
534
558
  DEFAULT_ENDPOINT = "retail.googleapis.com"
535
559
 
536
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
560
+ config_attr :endpoint, nil, ::String, nil
537
561
  config_attr :credentials, nil do |value|
538
562
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
539
563
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -548,6 +572,7 @@ module Google
548
572
  config_attr :metadata, nil, ::Hash, nil
549
573
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
550
574
  config_attr :quota_project, nil, ::String, nil
575
+ config_attr :universe_domain, nil, ::String, nil
551
576
 
552
577
  # @private
553
578
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module CompletionService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "retail.$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 `"retail.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 = "retail.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