google-cloud-dialogflow-cx-v3 0.23.0 → 0.24.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +33 -8
  4. data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +28 -6
  5. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/client.rb +35 -7
  6. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/operations.rb +33 -8
  7. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +32 -8
  9. data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb +34 -7
  10. data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/service_stub.rb +14 -2
  11. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +32 -8
  12. data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/client.rb +34 -7
  13. data/lib/google/cloud/dialogflow/cx/v3/deployments/rest/service_stub.rb +14 -2
  14. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +32 -8
  15. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/client.rb +34 -7
  16. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/service_stub.rb +14 -2
  17. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +33 -8
  18. data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +28 -6
  19. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/client.rb +35 -7
  20. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/operations.rb +33 -8
  21. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/service_stub.rb +14 -2
  22. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +32 -8
  23. data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/client.rb +34 -7
  24. data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/service_stub.rb +14 -2
  25. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +33 -8
  26. data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +28 -6
  27. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/client.rb +35 -7
  28. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/operations.rb +33 -8
  29. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/service_stub.rb +14 -2
  30. data/lib/google/cloud/dialogflow/cx/v3/generators/client.rb +32 -8
  31. data/lib/google/cloud/dialogflow/cx/v3/generators/rest/client.rb +34 -7
  32. data/lib/google/cloud/dialogflow/cx/v3/generators/rest/service_stub.rb +14 -2
  33. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +33 -8
  34. data/lib/google/cloud/dialogflow/cx/v3/intents/operations.rb +28 -6
  35. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/client.rb +35 -7
  36. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/operations.rb +33 -8
  37. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/service_stub.rb +14 -2
  38. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +32 -8
  39. data/lib/google/cloud/dialogflow/cx/v3/pages/rest/client.rb +34 -7
  40. data/lib/google/cloud/dialogflow/cx/v3/pages/rest/service_stub.rb +14 -2
  41. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +32 -8
  42. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/client.rb +34 -7
  43. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/rest/service_stub.rb +14 -2
  44. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +32 -8
  45. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/client.rb +34 -7
  46. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/rest/service_stub.rb +14 -2
  47. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +32 -8
  48. data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb +34 -7
  49. data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb +14 -2
  50. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +33 -8
  51. data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +28 -6
  52. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb +35 -7
  53. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/operations.rb +33 -8
  54. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/service_stub.rb +14 -2
  55. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +32 -8
  56. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/client.rb +34 -7
  57. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/rest/service_stub.rb +14 -2
  58. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  59. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +33 -8
  60. data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +28 -6
  61. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/client.rb +35 -7
  62. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/operations.rb +33 -8
  63. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/service_stub.rb +14 -2
  64. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +32 -8
  65. data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/client.rb +34 -7
  66. data/lib/google/cloud/dialogflow/cx/v3/webhooks/rest/service_stub.rb +14 -2
  67. data/proto_docs/google/api/client.rb +1 -0
  68. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +1 -0
  69. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +2 -0
  70. data/proto_docs/google/cloud/dialogflow/cx/v3/validation_message.rb +1 -0
  71. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +2 -0
  72. metadata +6 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: aabf3b81cc77f280edb14a33d092d2c5d56e6965e0e7fa36cd32ecfe12d767f8
4
- data.tar.gz: 0a33bb3dcf606b918238ed4cee01fedc62ddd5f878999c3856f67a4be8172fdb
3
+ metadata.gz: 5f92d3443703a457d3886af09886260b3aec231bd4f295cd84c6293006ceca17
4
+ data.tar.gz: 29460ca38f9c1c686baa3bb8892cb3a68355fb7bf5464ae52834624d2fa5963c
5
5
  SHA512:
6
- metadata.gz: 2c2bdb7f03e8353b2e0588ebdbc1caf436ba893e78711a14ec90b19307a87f0cf9bc9ad8e33107438d96fc41a398c8e484d876f883c6911b7f6d523583865f17
7
- data.tar.gz: c13836e47556d071471c18b4235896bc1f00dcb7da08f3aca02fff1a146387b36dc7d849869b8d77c4eca7d2cbbe494a41d5332c01e08f6ecb7c9e0c157ff355
6
+ metadata.gz: 6b2c2eaa6897f0aeeb8954677ee64b168a1f3930c1ca60a087d076f831f2d52c5ace6f09250bf64ff7e9e5ded2f8e4c3f2c829c2f1209c0b8e22981820bb6e31
7
+ data.tar.gz: 3c3f758cdea392aaba8febb3782e784e8c2b308404b61098471c2449b8e02b7bd4d17a45b1c2d503a4ffe9947525a48f668ea757983bbad2470ad35e16ed7121
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-dialogflow-cx-v3 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-dialogflow-cx-v3 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 DIALOGFLOW_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/dialogflow/cx/v3"
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::Dialogflow::CX::V3::Pages::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-dialogflow-cx-v3 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-dialogflow-cx-v3 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-dialogflow-cx-v3
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Dialogflow::CX::V3::Pages::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `DIALOGFLOW_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `DIALOGFLOW_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/dialogflow/cx/v3"
77
-
78
- ENV["DIALOGFLOW_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Dialogflow::CX::V3::Pages::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/dialogflow/cx/v3"
90
58
 
91
59
  client = ::Google::Cloud::Dialogflow::CX::V3::Pages::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/dialogflow/cx/v3"
100
68
 
101
69
  ::Google::Cloud::Dialogflow::CX::V3::Pages::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::Dialogflow::CX::V3::Pages::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-dialogflow-cx-v3
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/dialogflow/cx/v3"
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-dialogflow-cx-v3.
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::Dialogflow::CX::V3::Pages::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).
@@ -32,6 +32,9 @@ module Google
32
32
  # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Agent Agents}.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "dialogflow.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -102,6 +105,15 @@ module Google
102
105
  @config
103
106
  end
104
107
 
108
+ ##
109
+ # The effective universe domain
110
+ #
111
+ # @return [String]
112
+ #
113
+ def universe_domain
114
+ @agents_stub.universe_domain
115
+ end
116
+
105
117
  ##
106
118
  # Create a new Agents client object.
107
119
  #
@@ -135,8 +147,9 @@ module Google
135
147
  credentials = @config.credentials
136
148
  # Use self-signed JWT if the endpoint is unchanged from default,
137
149
  # but only if the default endpoint does not have a region prefix.
138
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
139
- !@config.endpoint.split(".").first.include?("-")
150
+ enable_self_signed_jwt = @config.endpoint.nil? ||
151
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
152
+ !@config.endpoint.split(".").first.include?("-"))
140
153
  credentials ||= Credentials.default scope: @config.scope,
141
154
  enable_self_signed_jwt: enable_self_signed_jwt
142
155
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -149,18 +162,22 @@ module Google
149
162
  config.credentials = credentials
150
163
  config.quota_project = @quota_project_id
151
164
  config.endpoint = @config.endpoint
165
+ config.universe_domain = @config.universe_domain
152
166
  end
153
167
 
154
168
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
155
169
  config.credentials = credentials
156
170
  config.quota_project = @quota_project_id
157
171
  config.endpoint = @config.endpoint
172
+ config.universe_domain = @config.universe_domain
158
173
  end
159
174
 
160
175
  @agents_stub = ::Gapic::ServiceStub.new(
161
176
  ::Google::Cloud::Dialogflow::CX::V3::Agents::Stub,
162
- credentials: credentials,
163
- endpoint: @config.endpoint,
177
+ credentials: credentials,
178
+ endpoint: @config.endpoint,
179
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
180
+ universe_domain: @config.universe_domain,
164
181
  channel_args: @config.channel_args,
165
182
  interceptors: @config.interceptors,
166
183
  channel_pool_config: @config.channel_pool
@@ -1272,9 +1289,9 @@ module Google
1272
1289
  # end
1273
1290
  #
1274
1291
  # @!attribute [rw] endpoint
1275
- # The hostname or hostname:port of the service endpoint.
1276
- # Defaults to `"dialogflow.googleapis.com"`.
1277
- # @return [::String]
1292
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1293
+ # nil, indicating to use the default endpoint in the current universe domain.
1294
+ # @return [::String,nil]
1278
1295
  # @!attribute [rw] credentials
1279
1296
  # Credentials to send with calls. You may provide any of the following types:
1280
1297
  # * (`String`) The path to a service account key file in JSON format
@@ -1320,13 +1337,20 @@ module Google
1320
1337
  # @!attribute [rw] quota_project
1321
1338
  # A separate project against which to charge quota.
1322
1339
  # @return [::String]
1340
+ # @!attribute [rw] universe_domain
1341
+ # The universe domain within which to make requests. This determines the
1342
+ # default endpoint URL. The default value of nil uses the environment
1343
+ # universe (usually the default "googleapis.com" universe).
1344
+ # @return [::String,nil]
1323
1345
  #
1324
1346
  class Configuration
1325
1347
  extend ::Gapic::Config
1326
1348
 
1349
+ # @private
1350
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1327
1351
  DEFAULT_ENDPOINT = "dialogflow.googleapis.com"
1328
1352
 
1329
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1353
+ config_attr :endpoint, nil, ::String, nil
1330
1354
  config_attr :credentials, nil do |value|
1331
1355
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1332
1356
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1341,6 +1365,7 @@ module Google
1341
1365
  config_attr :metadata, nil, ::Hash, nil
1342
1366
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1343
1367
  config_attr :quota_project, nil, ::String, nil
1368
+ config_attr :universe_domain, nil, ::String, nil
1344
1369
 
1345
1370
  # @private
1346
1371
  def initialize parent_config = nil
@@ -27,6 +27,9 @@ module Google
27
27
  module Agents
28
28
  # Service that implements Longrunning Operations API.
29
29
  class Operations
30
+ # @private
31
+ DEFAULT_ENDPOINT_TEMPLATE = "dialogflow.$UNIVERSE_DOMAIN$"
32
+
30
33
  # @private
31
34
  attr_reader :operations_stub
32
35
 
@@ -61,6 +64,15 @@ module Google
61
64
  @config
62
65
  end
63
66
 
67
+ ##
68
+ # The effective universe domain
69
+ #
70
+ # @return [String]
71
+ #
72
+ def universe_domain
73
+ @operations_stub.universe_domain
74
+ end
75
+
64
76
  ##
65
77
  # Create a new Operations client object.
66
78
  #
@@ -91,8 +103,10 @@ module Google
91
103
 
92
104
  @operations_stub = ::Gapic::ServiceStub.new(
93
105
  ::Google::Longrunning::Operations::Stub,
94
- credentials: credentials,
95
- endpoint: @config.endpoint,
106
+ credentials: credentials,
107
+ endpoint: @config.endpoint,
108
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
109
+ universe_domain: @config.universe_domain,
96
110
  channel_args: @config.channel_args,
97
111
  interceptors: @config.interceptors,
98
112
  channel_pool_config: @config.channel_pool
@@ -614,9 +628,9 @@ module Google
614
628
  # end
615
629
  #
616
630
  # @!attribute [rw] endpoint
617
- # The hostname or hostname:port of the service endpoint.
618
- # Defaults to `"dialogflow.googleapis.com"`.
619
- # @return [::String]
631
+ # A custom service endpoint, as a hostname or hostname:port. The default is
632
+ # nil, indicating to use the default endpoint in the current universe domain.
633
+ # @return [::String,nil]
620
634
  # @!attribute [rw] credentials
621
635
  # Credentials to send with calls. You may provide any of the following types:
622
636
  # * (`String`) The path to a service account key file in JSON format
@@ -662,13 +676,20 @@ module Google
662
676
  # @!attribute [rw] quota_project
663
677
  # A separate project against which to charge quota.
664
678
  # @return [::String]
679
+ # @!attribute [rw] universe_domain
680
+ # The universe domain within which to make requests. This determines the
681
+ # default endpoint URL. The default value of nil uses the environment
682
+ # universe (usually the default "googleapis.com" universe).
683
+ # @return [::String,nil]
665
684
  #
666
685
  class Configuration
667
686
  extend ::Gapic::Config
668
687
 
688
+ # @private
689
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
669
690
  DEFAULT_ENDPOINT = "dialogflow.googleapis.com"
670
691
 
671
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
692
+ config_attr :endpoint, nil, ::String, nil
672
693
  config_attr :credentials, nil do |value|
673
694
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
674
695
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -683,6 +704,7 @@ module Google
683
704
  config_attr :metadata, nil, ::Hash, nil
684
705
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
685
706
  config_attr :quota_project, nil, ::String, nil
707
+ config_attr :universe_domain, nil, ::String, nil
686
708
 
687
709
  # @private
688
710
  def initialize parent_config = nil
@@ -34,6 +34,9 @@ module Google
34
34
  # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Agent Agents}.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "dialogflow.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -104,6 +107,15 @@ module Google
104
107
  @config
105
108
  end
106
109
 
110
+ ##
111
+ # The effective universe domain
112
+ #
113
+ # @return [String]
114
+ #
115
+ def universe_domain
116
+ @agents_stub.universe_domain
117
+ end
118
+
107
119
  ##
108
120
  # Create a new Agents REST client object.
109
121
  #
@@ -131,8 +143,9 @@ module Google
131
143
  credentials = @config.credentials
132
144
  # Use self-signed JWT if the endpoint is unchanged from default,
133
145
  # but only if the default endpoint does not have a region prefix.
134
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
135
- !@config.endpoint.split(".").first.include?("-")
146
+ enable_self_signed_jwt = @config.endpoint.nil? ||
147
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
148
+ !@config.endpoint.split(".").first.include?("-"))
136
149
  credentials ||= Credentials.default scope: @config.scope,
137
150
  enable_self_signed_jwt: enable_self_signed_jwt
138
151
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -146,16 +159,23 @@ 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::Rest::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
  config.bindings_override = @config.bindings_override
156
171
  end
157
172
 
158
- @agents_stub = ::Google::Cloud::Dialogflow::CX::V3::Agents::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
173
+ @agents_stub = ::Google::Cloud::Dialogflow::CX::V3::Agents::Rest::ServiceStub.new(
174
+ endpoint: @config.endpoint,
175
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
176
+ universe_domain: @config.universe_domain,
177
+ credentials: credentials
178
+ )
159
179
  end
160
180
 
161
181
  ##
@@ -1186,9 +1206,9 @@ module Google
1186
1206
  # end
1187
1207
  #
1188
1208
  # @!attribute [rw] endpoint
1189
- # The hostname or hostname:port of the service endpoint.
1190
- # Defaults to `"dialogflow.googleapis.com"`.
1191
- # @return [::String]
1209
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1210
+ # nil, indicating to use the default endpoint in the current universe domain.
1211
+ # @return [::String,nil]
1192
1212
  # @!attribute [rw] credentials
1193
1213
  # Credentials to send with calls. You may provide any of the following types:
1194
1214
  # * (`String`) The path to a service account key file in JSON format
@@ -1225,13 +1245,20 @@ module Google
1225
1245
  # @!attribute [rw] quota_project
1226
1246
  # A separate project against which to charge quota.
1227
1247
  # @return [::String]
1248
+ # @!attribute [rw] universe_domain
1249
+ # The universe domain within which to make requests. This determines the
1250
+ # default endpoint URL. The default value of nil uses the environment
1251
+ # universe (usually the default "googleapis.com" universe).
1252
+ # @return [::String,nil]
1228
1253
  #
1229
1254
  class Configuration
1230
1255
  extend ::Gapic::Config
1231
1256
 
1257
+ # @private
1258
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1232
1259
  DEFAULT_ENDPOINT = "dialogflow.googleapis.com"
1233
1260
 
1234
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1261
+ config_attr :endpoint, nil, ::String, nil
1235
1262
  config_attr :credentials, nil do |value|
1236
1263
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1237
1264
  allowed.any? { |klass| klass === value }
@@ -1243,6 +1270,7 @@ module Google
1243
1270
  config_attr :metadata, nil, ::Hash, nil
1244
1271
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1245
1272
  config_attr :quota_project, nil, ::String, nil
1273
+ config_attr :universe_domain, nil, ::String, nil
1246
1274
 
1247
1275
  # @private
1248
1276
  # Overrides for http bindings for the RPCs of this service
@@ -27,6 +27,9 @@ module Google
27
27
  module Rest
28
28
  # Service that implements Longrunning Operations API.
29
29
  class Operations
30
+ # @private
31
+ DEFAULT_ENDPOINT_TEMPLATE = "dialogflow.$UNIVERSE_DOMAIN$"
32
+
30
33
  # @private
31
34
  attr_reader :operations_stub
32
35
 
@@ -61,6 +64,15 @@ module Google
61
64
  @config
62
65
  end
63
66
 
67
+ ##
68
+ # The effective universe domain
69
+ #
70
+ # @return [String]
71
+ #
72
+ def universe_domain
73
+ @operations_stub.universe_domain
74
+ end
75
+
64
76
  ##
65
77
  # Create a new Operations client object.
66
78
  #
@@ -85,8 +97,10 @@ module Google
85
97
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
86
98
 
87
99
  @operations_stub = OperationsServiceStub.new(
88
- endpoint: @config.endpoint,
89
- credentials: credentials
100
+ endpoint: @config.endpoint,
101
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
102
+ universe_domain: @config.universe_domain,
103
+ credentials: credentials
90
104
  )
91
105
 
92
106
  # Used by an LRO wrapper for some methods of this service
@@ -479,9 +493,9 @@ module Google
479
493
  # end
480
494
  #
481
495
  # @!attribute [rw] endpoint
482
- # The hostname or hostname:port of the service endpoint.
483
- # Defaults to `"dialogflow.googleapis.com"`.
484
- # @return [::String]
496
+ # A custom service endpoint, as a hostname or hostname:port. The default is
497
+ # nil, indicating to use the default endpoint in the current universe domain.
498
+ # @return [::String,nil]
485
499
  # @!attribute [rw] credentials
486
500
  # Credentials to send with calls. You may provide any of the following types:
487
501
  # * (`String`) The path to a service account key file in JSON format
@@ -518,13 +532,20 @@ module Google
518
532
  # @!attribute [rw] quota_project
519
533
  # A separate project against which to charge quota.
520
534
  # @return [::String]
535
+ # @!attribute [rw] universe_domain
536
+ # The universe domain within which to make requests. This determines the
537
+ # default endpoint URL. The default value of nil uses the environment
538
+ # universe (usually the default "googleapis.com" universe).
539
+ # @return [::String,nil]
521
540
  #
522
541
  class Configuration
523
542
  extend ::Gapic::Config
524
543
 
544
+ # @private
545
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
525
546
  DEFAULT_ENDPOINT = "dialogflow.googleapis.com"
526
547
 
527
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
548
+ config_attr :endpoint, nil, ::String, nil
528
549
  config_attr :credentials, nil do |value|
529
550
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
530
551
  allowed.any? { |klass| klass === value }
@@ -536,6 +557,7 @@ module Google
536
557
  config_attr :metadata, nil, ::Hash, nil
537
558
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
538
559
  config_attr :quota_project, nil, ::String, nil
560
+ config_attr :universe_domain, nil, ::String, nil
539
561
 
540
562
  # @private
541
563
  def initialize parent_config = nil
@@ -618,12 +640,15 @@ module Google
618
640
  # Service stub contains baseline method implementations
619
641
  # including transcoding, making the REST call, and deserialing the response.
620
642
  class OperationsServiceStub
621
- def initialize endpoint:, credentials:
643
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
622
644
  # These require statements are intentionally placed here to initialize
623
645
  # the REST modules only when it's required.
624
646
  require "gapic/rest"
625
647
 
626
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
648
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
649
+ endpoint_template: endpoint_template,
650
+ universe_domain: universe_domain,
651
+ credentials: credentials
627
652
  end
628
653
 
629
654
  ##