google-cloud-dialogflow-cx 0.4.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 724af0ba534ae73630b061f8a6be69367e41a7e0ac7f85cf05e03baf22407e65
4
- data.tar.gz: 1f6b993c0c335122a9a0f54bca18110d347dea23e5f18c92c1f224b567c3f26f
3
+ metadata.gz: 026e8b9f42980aeb40675d7f6e4d13b23510440b0ba10e93d3399cb10b9ae40a
4
+ data.tar.gz: b6289fe2b03f377ef3c2d62384f580a3a29c5084b2e46ac9068f2b4a70ac1b88
5
5
  SHA512:
6
- metadata.gz: cdcfb5171c94d8e277216806af12f499a2692b9a40aaa0e2ee3692e4d9379aae9936c7babe34cb6661824af779cab4ea856bacee8025a00fe5c89fb4ec217773
7
- data.tar.gz: 1ff806d01f6faeda4616922505415022688e056f6cb7211cbb88809ca80deda6a3eaa46e639125484834a14a9c0857b470f7564b90d455894194a27ad78547e0
6
+ metadata.gz: b6920b32292c59068f51311f3b0871e3891fe970730ed034325ed53addff00ce4bd60592498dc19b1b70c125b1cf492a9ced718ef58cc600ddf4f7aa50e0d1f7
7
+ data.tar.gz: a25847b4dbbf238f8827b5773402b29cf6a9338fccfde7cfb22fb0c63e61c61e7406ab510a698d943d85a9966ec00b0e019a274069af3ce210c3f9d3ca4f9edd
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-dialogflow-cx 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 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"
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.pages
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-dialogflow-cx 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 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
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"
77
-
78
- ENV["DIALOGFLOW_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = Google::Cloud::Dialogflow::CX.pages
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"
90
58
 
91
59
  client = Google::Cloud::Dialogflow::CX.pages 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"
100
68
 
101
69
  Google::Cloud::Dialogflow::CX.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.pages
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
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"
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.
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.pages
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/README.md CHANGED
@@ -16,7 +16,7 @@ for this library, google-cloud-dialogflow-cx, to see the convenience methods for
16
16
  constructing client objects. Reference documentation for the client objects
17
17
  themselves can be found in the client library documentation for the versioned
18
18
  client gems:
19
- [google-cloud-dialogflow-cx-v3](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest).
19
+ [google-cloud-dialogflow-cx-v3](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest).
20
20
 
21
21
  See also the [Product Documentation](https://cloud.google.com/dialogflow)
22
22
  for more usage information.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dialogflow
23
23
  module CX
24
- VERSION = "0.4.0"
24
+ VERSION = "1.1.0"
25
25
  end
26
26
  end
27
27
  end
@@ -29,7 +29,7 @@ require "google/cloud/config"
29
29
 
30
30
  # Set the default configuration
31
31
  ::Google::Cloud.configure.add_config! :dialogflow_cx do |config|
32
- config.add_field! :endpoint, "dialogflow.googleapis.com", match: ::String
32
+ config.add_field! :endpoint, nil, match: ::String
33
33
  config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
34
  config.add_field! :scope, nil, match: [::Array, ::String]
35
35
  config.add_field! :lib_name, nil, match: ::String
@@ -39,6 +39,7 @@ require "google/cloud/config"
39
39
  config.add_field! :metadata, nil, match: ::Hash
40
40
  config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
41
  config.add_field! :quota_project, nil, match: ::String
42
+ config.add_field! :universe_domain, nil, match: ::String
42
43
  end
43
44
 
44
45
  module Google
@@ -49,7 +50,7 @@ module Google
49
50
  # Create a new client object for Pages.
50
51
  #
51
52
  # By default, this returns an instance of
52
- # [Google::Cloud::Dialogflow::CX::V3::Pages::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Pages/Client.html)
53
+ # [Google::Cloud::Dialogflow::CX::V3::Pages::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Pages-Client)
53
54
  # for a gRPC client for version V3 of the API.
54
55
  # However, you can specify a different API version by passing it in the
55
56
  # `version` parameter. If the Pages service is
@@ -83,7 +84,7 @@ module Google
83
84
  # Create a new client object for Flows.
84
85
  #
85
86
  # By default, this returns an instance of
86
- # [Google::Cloud::Dialogflow::CX::V3::Flows::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Flows/Client.html)
87
+ # [Google::Cloud::Dialogflow::CX::V3::Flows::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Flows-Client)
87
88
  # for a gRPC client for version V3 of the API.
88
89
  # However, you can specify a different API version by passing it in the
89
90
  # `version` parameter. If the Flows service is
@@ -117,7 +118,7 @@ module Google
117
118
  # Create a new client object for Agents.
118
119
  #
119
120
  # By default, this returns an instance of
120
- # [Google::Cloud::Dialogflow::CX::V3::Agents::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Agents/Client.html)
121
+ # [Google::Cloud::Dialogflow::CX::V3::Agents::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Agents-Client)
121
122
  # for a gRPC client for version V3 of the API.
122
123
  # However, you can specify a different API version by passing it in the
123
124
  # `version` parameter. If the Agents service is
@@ -151,7 +152,7 @@ module Google
151
152
  # Create a new client object for Changelogs.
152
153
  #
153
154
  # By default, this returns an instance of
154
- # [Google::Cloud::Dialogflow::CX::V3::Changelogs::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Changelogs/Client.html)
155
+ # [Google::Cloud::Dialogflow::CX::V3::Changelogs::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Changelogs-Client)
155
156
  # for a gRPC client for version V3 of the API.
156
157
  # However, you can specify a different API version by passing it in the
157
158
  # `version` parameter. If the Changelogs service is
@@ -185,7 +186,7 @@ module Google
185
186
  # Create a new client object for Deployments.
186
187
  #
187
188
  # By default, this returns an instance of
188
- # [Google::Cloud::Dialogflow::CX::V3::Deployments::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Deployments/Client.html)
189
+ # [Google::Cloud::Dialogflow::CX::V3::Deployments::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Deployments-Client)
189
190
  # for a gRPC client for version V3 of the API.
190
191
  # However, you can specify a different API version by passing it in the
191
192
  # `version` parameter. If the Deployments service is
@@ -219,7 +220,7 @@ module Google
219
220
  # Create a new client object for EntityTypes.
220
221
  #
221
222
  # By default, this returns an instance of
222
- # [Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/EntityTypes/Client.html)
223
+ # [Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-EntityTypes-Client)
223
224
  # for a gRPC client for version V3 of the API.
224
225
  # However, you can specify a different API version by passing it in the
225
226
  # `version` parameter. If the EntityTypes service is
@@ -253,7 +254,7 @@ module Google
253
254
  # Create a new client object for Intents.
254
255
  #
255
256
  # By default, this returns an instance of
256
- # [Google::Cloud::Dialogflow::CX::V3::Intents::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Intents/Client.html)
257
+ # [Google::Cloud::Dialogflow::CX::V3::Intents::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Intents-Client)
257
258
  # for a gRPC client for version V3 of the API.
258
259
  # However, you can specify a different API version by passing it in the
259
260
  # `version` parameter. If the Intents service is
@@ -287,7 +288,7 @@ module Google
287
288
  # Create a new client object for SessionEntityTypes.
288
289
  #
289
290
  # By default, this returns an instance of
290
- # [Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/SessionEntityTypes/Client.html)
291
+ # [Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-SessionEntityTypes-Client)
291
292
  # for a gRPC client for version V3 of the API.
292
293
  # However, you can specify a different API version by passing it in the
293
294
  # `version` parameter. If the SessionEntityTypes service is
@@ -322,7 +323,7 @@ module Google
322
323
  # Create a new client object for Sessions.
323
324
  #
324
325
  # By default, this returns an instance of
325
- # [Google::Cloud::Dialogflow::CX::V3::Sessions::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Sessions/Client.html)
326
+ # [Google::Cloud::Dialogflow::CX::V3::Sessions::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Sessions-Client)
326
327
  # for a gRPC client for version V3 of the API.
327
328
  # However, you can specify a different API version by passing it in the
328
329
  # `version` parameter. If the Sessions service is
@@ -359,7 +360,7 @@ module Google
359
360
  # Create a new client object for TransitionRouteGroups.
360
361
  #
361
362
  # By default, this returns an instance of
362
- # [Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/TransitionRouteGroups/Client.html)
363
+ # [Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-TransitionRouteGroups-Client)
363
364
  # for a gRPC client for version V3 of the API.
364
365
  # However, you can specify a different API version by passing it in the
365
366
  # `version` parameter. If the TransitionRouteGroups service is
@@ -394,7 +395,7 @@ module Google
394
395
  # Create a new client object for TestCases.
395
396
  #
396
397
  # By default, this returns an instance of
397
- # [Google::Cloud::Dialogflow::CX::V3::TestCases::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/TestCases/Client.html)
398
+ # [Google::Cloud::Dialogflow::CX::V3::TestCases::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-TestCases-Client)
398
399
  # for a gRPC client for version V3 of the API.
399
400
  # However, you can specify a different API version by passing it in the
400
401
  # `version` parameter. If the TestCases service is
@@ -429,7 +430,7 @@ module Google
429
430
  # Create a new client object for Webhooks.
430
431
  #
431
432
  # By default, this returns an instance of
432
- # [Google::Cloud::Dialogflow::CX::V3::Webhooks::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Webhooks/Client.html)
433
+ # [Google::Cloud::Dialogflow::CX::V3::Webhooks::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Webhooks-Client)
433
434
  # for a gRPC client for version V3 of the API.
434
435
  # However, you can specify a different API version by passing it in the
435
436
  # `version` parameter. If the Webhooks service is
@@ -463,7 +464,7 @@ module Google
463
464
  # Create a new client object for Environments.
464
465
  #
465
466
  # By default, this returns an instance of
466
- # [Google::Cloud::Dialogflow::CX::V3::Environments::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Environments/Client.html)
467
+ # [Google::Cloud::Dialogflow::CX::V3::Environments::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Environments-Client)
467
468
  # for a gRPC client for version V3 of the API.
468
469
  # However, you can specify a different API version by passing it in the
469
470
  # `version` parameter. If the Environments service is
@@ -498,7 +499,7 @@ module Google
498
499
  # Create a new client object for Experiments.
499
500
  #
500
501
  # By default, this returns an instance of
501
- # [Google::Cloud::Dialogflow::CX::V3::Experiments::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Experiments/Client.html)
502
+ # [Google::Cloud::Dialogflow::CX::V3::Experiments::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Experiments-Client)
502
503
  # for a gRPC client for version V3 of the API.
503
504
  # However, you can specify a different API version by passing it in the
504
505
  # `version` parameter. If the Experiments service is
@@ -528,11 +529,45 @@ module Google
528
529
  service_module.const_get(:Client).new(&block)
529
530
  end
530
531
 
532
+ ##
533
+ # Create a new client object for Generators.
534
+ #
535
+ # By default, this returns an instance of
536
+ # [Google::Cloud::Dialogflow::CX::V3::Generators::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Generators-Client)
537
+ # for a gRPC client for version V3 of the API.
538
+ # However, you can specify a different API version by passing it in the
539
+ # `version` parameter. If the Generators service is
540
+ # supported by that API version, and the corresponding gem is available, the
541
+ # appropriate versioned client will be returned.
542
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
543
+ # the `transport` parameter.
544
+ #
545
+ # ## About Generators
546
+ #
547
+ # Service for managing Generators
548
+ #
549
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
550
+ # Defaults to `:v3`.
551
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
552
+ # @return [::Object] A client object for the specified version.
553
+ #
554
+ def self.generators version: :v3, transport: :grpc, &block
555
+ require "google/cloud/dialogflow/cx/#{version.to_s.downcase}"
556
+
557
+ package_name = Google::Cloud::Dialogflow::CX
558
+ .constants
559
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
560
+ .first
561
+ service_module = Google::Cloud::Dialogflow::CX.const_get(package_name).const_get(:Generators)
562
+ service_module = service_module.const_get(:Rest) if transport == :rest
563
+ service_module.const_get(:Client).new(&block)
564
+ end
565
+
531
566
  ##
532
567
  # Create a new client object for SecuritySettingsService.
533
568
  #
534
569
  # By default, this returns an instance of
535
- # [Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/SecuritySettingsService/Client.html)
570
+ # [Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-SecuritySettingsService-Client)
536
571
  # for a gRPC client for version V3 of the API.
537
572
  # However, you can specify a different API version by passing it in the
538
573
  # `version` parameter. If the SecuritySettingsService service is
@@ -566,7 +601,7 @@ module Google
566
601
  # Create a new client object for Versions.
567
602
  #
568
603
  # By default, this returns an instance of
569
- # [Google::Cloud::Dialogflow::CX::V3::Versions::Client](https://googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Versions/Client.html)
604
+ # [Google::Cloud::Dialogflow::CX::V3::Versions::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Versions-Client)
570
605
  # for a gRPC client for version V3 of the API.
571
606
  # However, you can specify a different API version by passing it in the
572
607
  # `version` parameter. If the Versions service is
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dialogflow-cx
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-03-09 00:00:00.000000000 Z
11
+ date: 2024-01-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-cloud-core
@@ -30,7 +30,7 @@ dependencies:
30
30
  requirements:
31
31
  - - ">="
32
32
  - !ruby/object:Gem::Version
33
- version: '0.15'
33
+ version: '0.24'
34
34
  - - "<"
35
35
  - !ruby/object:Gem::Version
36
36
  version: 2.a
@@ -40,7 +40,7 @@ dependencies:
40
40
  requirements:
41
41
  - - ">="
42
42
  - !ruby/object:Gem::Version
43
- version: '0.15'
43
+ version: '0.24'
44
44
  - - "<"
45
45
  - !ruby/object:Gem::Version
46
46
  version: 2.a
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
193
193
  - !ruby/object:Gem::Version
194
194
  version: '0'
195
195
  requirements: []
196
- rubygems_version: 3.4.2
196
+ rubygems_version: 3.5.3
197
197
  signing_key:
198
198
  specification_version: 4
199
199
  summary: API Client library for the Dialogflow CX API