google-cloud-recommendation_engine-v1beta1 0.7.0 → 0.8.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 (21) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb +32 -8
  4. data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/operations.rb +28 -6
  5. data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/rest/client.rb +34 -7
  6. data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/rest/operations.rb +33 -8
  7. data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/client.rb +31 -8
  9. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/client.rb +33 -7
  10. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/service_stub.rb +14 -2
  11. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_service/client.rb +31 -8
  12. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_service/rest/client.rb +33 -7
  13. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_service/rest/service_stub.rb +14 -2
  14. data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/client.rb +32 -8
  15. data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/operations.rb +28 -6
  16. data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/rest/client.rb +34 -7
  17. data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/rest/operations.rb +33 -8
  18. data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/rest/service_stub.rb +14 -2
  19. data/lib/google/cloud/recommendation_engine/v1beta1/version.rb +1 -1
  20. data/proto_docs/google/api/client.rb +14 -0
  21. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4ee84bc4283f46788c7e4adbd46b9c3a33ab617ae90d276944cd0e8c52829b4e
4
- data.tar.gz: 18c1b72c372044544915c5a145d56dc2a820908d119598b423f8263bc921dd46
3
+ metadata.gz: 2786c56e87953cfab3ec27dd21f484f22a10c62ac700cab34008594d701f6dee
4
+ data.tar.gz: e83a27f6e2b5fc9289218be29def91a821652d1eb294efc1dcc94e345843e014
5
5
  SHA512:
6
- metadata.gz: dea534dee0f0722f3ee1a83106da56333df5b3c48ff835feb09a3895297176c84e392093d7492771b1dbfcd631062432d3d852f6861d1ea9ea33819745b6404e
7
- data.tar.gz: b008ac4d5789ee4aef6846209ca7d4569fc7668de82a4001c9653a7fecbc9aac2654179b6fd23150e8199921cc1045e84d6b9490fcac3cc4601970546d69b23e
6
+ metadata.gz: 2c0d77b61de5fe3cc7500404c69c568050525403adc01dbaa3fe37ada717a57fd0aaf30a1cf3f035b96391f4415e8ca435ccb0d5334304677c4a4494afaea5cc
7
+ data.tar.gz: 55526295c4e6d3c847d46d3285a1abce9ba12922e438618c91cfb68502207faf20e88b5f330dc940c5d8c0ff4315bd8181ff4cc503ea883d2dc2205ab7989aec
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-recommendation_engine-v1beta1 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-recommendation_engine-v1beta1 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 RECOMMENDATION_ENGINE_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/recommendation_engine/v1beta1"
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::RecommendationEngine::V1beta1::CatalogService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-recommendation_engine-v1beta1 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-recommendation_engine-v1beta1 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-recommendation_engine-v1beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `RECOMMENDATION_ENGINE_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `RECOMMENDATION_ENGINE_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/recommendation_engine/v1beta1"
77
-
78
- ENV["RECOMMENDATION_ENGINE_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::RecommendationEngine::V1beta1::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/recommendation_engine/v1beta1"
90
58
 
91
59
  client = ::Google::Cloud::RecommendationEngine::V1beta1::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/recommendation_engine/v1beta1"
100
68
 
101
69
  ::Google::Cloud::RecommendationEngine::V1beta1::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::RecommendationEngine::V1beta1::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-recommendation_engine-v1beta1
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/recommendation_engine/v1beta1"
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-recommendation_engine-v1beta1.
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::RecommendationEngine::V1beta1::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).
data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb CHANGED
@@ -30,6 +30,9 @@ module Google
30
30
  # Service for ingesting catalog information of the customer's website.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "recommendationengine.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -120,6 +123,15 @@ module Google
120
123
  @config
121
124
  end
122
125
 
126
+ ##
127
+ # The effective universe domain
128
+ #
129
+ # @return [String]
130
+ #
131
+ def universe_domain
132
+ @catalog_service_stub.universe_domain
133
+ end
134
+
123
135
  ##
124
136
  # Create a new CatalogService client object.
125
137
  #
@@ -153,8 +165,9 @@ module Google
153
165
  credentials = @config.credentials
154
166
  # Use self-signed JWT if the endpoint is unchanged from default,
155
167
  # but only if the default endpoint does not have a region prefix.
156
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
157
- !@config.endpoint.split(".").first.include?("-")
168
+ enable_self_signed_jwt = @config.endpoint.nil? ||
169
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
170
+ !@config.endpoint.split(".").first.include?("-"))
158
171
  credentials ||= Credentials.default scope: @config.scope,
159
172
  enable_self_signed_jwt: enable_self_signed_jwt
160
173
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -167,12 +180,15 @@ module Google
167
180
  config.credentials = credentials
168
181
  config.quota_project = @quota_project_id
169
182
  config.endpoint = @config.endpoint
183
+ config.universe_domain = @config.universe_domain
170
184
  end
171
185
 
172
186
  @catalog_service_stub = ::Gapic::ServiceStub.new(
173
187
  ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Stub,
174
- credentials: credentials,
175
- endpoint: @config.endpoint,
188
+ credentials: credentials,
189
+ endpoint: @config.endpoint,
190
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
191
+ universe_domain: @config.universe_domain,
176
192
  channel_args: @config.channel_args,
177
193
  interceptors: @config.interceptors,
178
194
  channel_pool_config: @config.channel_pool
@@ -776,9 +792,9 @@ module Google
776
792
  # end
777
793
  #
778
794
  # @!attribute [rw] endpoint
779
- # The hostname or hostname:port of the service endpoint.
780
- # Defaults to `"recommendationengine.googleapis.com"`.
781
- # @return [::String]
795
+ # A custom service endpoint, as a hostname or hostname:port. The default is
796
+ # nil, indicating to use the default endpoint in the current universe domain.
797
+ # @return [::String,nil]
782
798
  # @!attribute [rw] credentials
783
799
  # Credentials to send with calls. You may provide any of the following types:
784
800
  # * (`String`) The path to a service account key file in JSON format
@@ -824,13 +840,20 @@ module Google
824
840
  # @!attribute [rw] quota_project
825
841
  # A separate project against which to charge quota.
826
842
  # @return [::String]
843
+ # @!attribute [rw] universe_domain
844
+ # The universe domain within which to make requests. This determines the
845
+ # default endpoint URL. The default value of nil uses the environment
846
+ # universe (usually the default "googleapis.com" universe).
847
+ # @return [::String,nil]
827
848
  #
828
849
  class Configuration
829
850
  extend ::Gapic::Config
830
851
 
852
+ # @private
853
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
831
854
  DEFAULT_ENDPOINT = "recommendationengine.googleapis.com"
832
855
 
833
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
856
+ config_attr :endpoint, nil, ::String, nil
834
857
  config_attr :credentials, nil do |value|
835
858
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
836
859
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -845,6 +868,7 @@ module Google
845
868
  config_attr :metadata, nil, ::Hash, nil
846
869
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
847
870
  config_attr :quota_project, nil, ::String, nil
871
+ config_attr :universe_domain, nil, ::String, nil
848
872
 
849
873
  # @private
850
874
  def initialize parent_config = nil
data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module CatalogService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "recommendationengine.$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 `"recommendationengine.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 = "recommendationengine.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/recommendation_engine/v1beta1/catalog_service/rest/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # Service for ingesting catalog information of the customer's website.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "recommendationengine.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -122,6 +125,15 @@ module Google
122
125
  @config
123
126
  end
124
127
 
128
+ ##
129
+ # The effective universe domain
130
+ #
131
+ # @return [String]
132
+ #
133
+ def universe_domain
134
+ @catalog_service_stub.universe_domain
135
+ end
136
+
125
137
  ##
126
138
  # Create a new CatalogService REST client object.
127
139
  #
@@ -149,8 +161,9 @@ module Google
149
161
  credentials = @config.credentials
150
162
  # Use self-signed JWT if the endpoint is unchanged from default,
151
163
  # but only if the default endpoint does not have a region prefix.
152
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
153
- !@config.endpoint.split(".").first.include?("-")
164
+ enable_self_signed_jwt = @config.endpoint.nil? ||
165
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
166
+ !@config.endpoint.split(".").first.include?("-"))
154
167
  credentials ||= Credentials.default scope: @config.scope,
155
168
  enable_self_signed_jwt: enable_self_signed_jwt
156
169
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -164,9 +177,15 @@ module Google
164
177
  config.credentials = credentials
165
178
  config.quota_project = @quota_project_id
166
179
  config.endpoint = @config.endpoint
180
+ config.universe_domain = @config.universe_domain
167
181
  end
168
182
 
169
- @catalog_service_stub = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
183
+ @catalog_service_stub = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Rest::ServiceStub.new(
184
+ endpoint: @config.endpoint,
185
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
186
+ universe_domain: @config.universe_domain,
187
+ credentials: credentials
188
+ )
170
189
  end
171
190
 
172
191
  ##
@@ -724,9 +743,9 @@ module Google
724
743
  # end
725
744
  #
726
745
  # @!attribute [rw] endpoint
727
- # The hostname or hostname:port of the service endpoint.
728
- # Defaults to `"recommendationengine.googleapis.com"`.
729
- # @return [::String]
746
+ # A custom service endpoint, as a hostname or hostname:port. The default is
747
+ # nil, indicating to use the default endpoint in the current universe domain.
748
+ # @return [::String,nil]
730
749
  # @!attribute [rw] credentials
731
750
  # Credentials to send with calls. You may provide any of the following types:
732
751
  # * (`String`) The path to a service account key file in JSON format
@@ -763,13 +782,20 @@ module Google
763
782
  # @!attribute [rw] quota_project
764
783
  # A separate project against which to charge quota.
765
784
  # @return [::String]
785
+ # @!attribute [rw] universe_domain
786
+ # The universe domain within which to make requests. This determines the
787
+ # default endpoint URL. The default value of nil uses the environment
788
+ # universe (usually the default "googleapis.com" universe).
789
+ # @return [::String,nil]
766
790
  #
767
791
  class Configuration
768
792
  extend ::Gapic::Config
769
793
 
794
+ # @private
795
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
770
796
  DEFAULT_ENDPOINT = "recommendationengine.googleapis.com"
771
797
 
772
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
798
+ config_attr :endpoint, nil, ::String, nil
773
799
  config_attr :credentials, nil do |value|
774
800
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
775
801
  allowed.any? { |klass| klass === value }
@@ -781,6 +807,7 @@ module Google
781
807
  config_attr :metadata, nil, ::Hash, nil
782
808
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
783
809
  config_attr :quota_project, nil, ::String, nil
810
+ config_attr :universe_domain, nil, ::String, nil
784
811
 
785
812
  # @private
786
813
  def initialize parent_config = nil
data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/rest/operations.rb CHANGED
@@ -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 = "recommendationengine.$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 `"recommendationengine.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 = "recommendationengine.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
  ##
data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/rest/service_stub.rb CHANGED
@@ -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 create_catalog_item REST call
45
57
  #