google-cloud-discovery_engine 0.2.0 → 0.4.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: bf6ed7e36135a6f8f82f0049da4e999e28f664f251e83bc5fe93467431538b3b
4
- data.tar.gz: 221b471702b29c903a5e00a793d8f873faaddf0649c1cc2a5278a4c370946221
3
+ metadata.gz: 5188ced016496f4477ba293c19455c03146dfcc466d4daf7940a137d23f7c6b2
4
+ data.tar.gz: 366250390327a811fba9bd7d13c32bc8e459dd6d8641b27aaffe570f0b1c278d
5
5
  SHA512:
6
- metadata.gz: 87b3476fdd718389c1e3dda30d4adf04400cafdd40644d4bb17feb8ab807df6927a89f547c4cca1be3ab7622b11d3a759845a4726bae4f534f08dcb1ac4ee0c3
7
- data.tar.gz: 0ecd42c54cae5941335fd60b1b29e6b602470bfb3d76edf153c6e9457727fdcd24a5ca654724425a845403b56a986aaf6746898f0194e5c009fc73d2bb7bafd3
6
+ metadata.gz: 4f385d09657573aa6faa8b8eda52d477825e7385b178d4b1a4d8e8c39f0f0e8f8ce58a8cae359cb394c32b3f92ecad84112593beeac3afd72c011e84c5e7f866
7
+ data.tar.gz: 7ab19b1710702e7665eeab6214d4f48fff54edc788b9b9fc44aaa54c29b7436a95ab9060ed2c320cfb39b7cd787c383b438a8833ff1cf3c4cc7ba4d36efcbedf
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-discovery_engine 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-discovery_engine 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 GOOGLE_CLOUD_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/discovery_engine"
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::DiscoveryEngine.completion_service
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-discovery_engine 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-discovery_engine 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-discovery_engine
66
- checks for credentials are configured on the service Credentials class (such as
67
- `::Google::Cloud::DiscoveryEngine::V1::CompletionService::Credentials`):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `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)
72
41
 
73
- ```ruby
74
- require "google/cloud/discovery_engine"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = Google::Cloud::DiscoveryEngine.completion_service
79
- ```
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).
80
49
 
81
- ### 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.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/discovery_engine"
88
58
 
89
59
  client = Google::Cloud::DiscoveryEngine.completion_service do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/discovery_engine"
98
68
 
99
69
  Google::Cloud::DiscoveryEngine.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = Google::Cloud::DiscoveryEngine.completion_service
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- 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.
111
82
 
112
- 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).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 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-discovery_engine
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *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
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/discovery_engine"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-discovery_engine.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = Google::Cloud::DiscoveryEngine.completion_service
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *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.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- 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.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- 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).
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module DiscoveryEngine
23
- VERSION = "0.2.0"
23
+ VERSION = "0.4.0"
24
24
  end
25
25
  end
26
26
  end
@@ -29,7 +29,7 @@ require "google/cloud/config"
29
29
 
30
30
  # Set the default configuration
31
31
  ::Google::Cloud.configure.add_config! :discovery_engine do |config|
32
- config.add_field! :endpoint, "discoveryengine.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
@@ -146,6 +147,41 @@ module Google
146
147
  service_module.const_get(:Client).new(&block)
147
148
  end
148
149
 
150
+ ##
151
+ # Create a new client object for DataStoreService.
152
+ #
153
+ # By default, this returns an instance of
154
+ # [Google::Cloud::DiscoveryEngine::V1::DataStoreService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-DataStoreService-Client)
155
+ # for a gRPC client for version V1 of the API.
156
+ # However, you can specify a different API version by passing it in the
157
+ # `version` parameter. If the DataStoreService service is
158
+ # supported by that API version, and the corresponding gem is available, the
159
+ # appropriate versioned client will be returned.
160
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
161
+ # the `transport` parameter.
162
+ #
163
+ # ## About DataStoreService
164
+ #
165
+ # Service for managing DataStore
166
+ # configuration.
167
+ #
168
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
169
+ # Defaults to `:v1`.
170
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
171
+ # @return [::Object] A client object for the specified version.
172
+ #
173
+ def self.data_store_service version: :v1, transport: :grpc, &block
174
+ require "google/cloud/discovery_engine/#{version.to_s.downcase}"
175
+
176
+ package_name = Google::Cloud::DiscoveryEngine
177
+ .constants
178
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
179
+ .first
180
+ service_module = Google::Cloud::DiscoveryEngine.const_get(package_name).const_get(:DataStoreService)
181
+ service_module = service_module.const_get(:Rest) if transport == :rest
182
+ service_module.const_get(:Client).new(&block)
183
+ end
184
+
149
185
  ##
150
186
  # Create a new client object for DocumentService.
151
187
  #
@@ -181,6 +217,41 @@ module Google
181
217
  service_module.const_get(:Client).new(&block)
182
218
  end
183
219
 
220
+ ##
221
+ # Create a new client object for EngineService.
222
+ #
223
+ # By default, this returns an instance of
224
+ # [Google::Cloud::DiscoveryEngine::V1::EngineService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-EngineService-Client)
225
+ # for a gRPC client for version V1 of the API.
226
+ # However, you can specify a different API version by passing it in the
227
+ # `version` parameter. If the EngineService service is
228
+ # supported by that API version, and the corresponding gem is available, the
229
+ # appropriate versioned client will be returned.
230
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
231
+ # the `transport` parameter.
232
+ #
233
+ # ## About EngineService
234
+ #
235
+ # Service for managing Engine
236
+ # configuration.
237
+ #
238
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
239
+ # Defaults to `:v1`.
240
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
241
+ # @return [::Object] A client object for the specified version.
242
+ #
243
+ def self.engine_service version: :v1, transport: :grpc, &block
244
+ require "google/cloud/discovery_engine/#{version.to_s.downcase}"
245
+
246
+ package_name = Google::Cloud::DiscoveryEngine
247
+ .constants
248
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
249
+ .first
250
+ service_module = Google::Cloud::DiscoveryEngine.const_get(package_name).const_get(:EngineService)
251
+ service_module = service_module.const_get(:Rest) if transport == :rest
252
+ service_module.const_get(:Client).new(&block)
253
+ end
254
+
184
255
  ##
185
256
  # Create a new client object for SchemaService.
186
257
  #
@@ -215,6 +286,40 @@ module Google
215
286
  service_module.const_get(:Client).new(&block)
216
287
  end
217
288
 
289
+ ##
290
+ # Create a new client object for SiteSearchEngineService.
291
+ #
292
+ # By default, this returns an instance of
293
+ # [Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-SiteSearchEngineService-Client)
294
+ # for a gRPC client for version V1 of the API.
295
+ # However, you can specify a different API version by passing it in the
296
+ # `version` parameter. If the SiteSearchEngineService service is
297
+ # supported by that API version, and the corresponding gem is available, the
298
+ # appropriate versioned client will be returned.
299
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
300
+ # the `transport` parameter.
301
+ #
302
+ # ## About SiteSearchEngineService
303
+ #
304
+ # Service for managing site search related resources.
305
+ #
306
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
307
+ # Defaults to `:v1`.
308
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
309
+ # @return [::Object] A client object for the specified version.
310
+ #
311
+ def self.site_search_engine_service version: :v1, transport: :grpc, &block
312
+ require "google/cloud/discovery_engine/#{version.to_s.downcase}"
313
+
314
+ package_name = Google::Cloud::DiscoveryEngine
315
+ .constants
316
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
317
+ .first
318
+ service_module = Google::Cloud::DiscoveryEngine.const_get(package_name).const_get(:SiteSearchEngineService)
319
+ service_module = service_module.const_get(:Rest) if transport == :rest
320
+ service_module.const_get(:Client).new(&block)
321
+ end
322
+
218
323
  ##
219
324
  # Create a new client object for UserEventService.
220
325
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-discovery_engine
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.4.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-09-07 00:00:00.000000000 Z
11
+ date: 2024-02-14 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.0'
33
+ version: '0.4'
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.0'
43
+ version: '0.4'
44
44
  - - "<"
45
45
  - !ruby/object:Gem::Version
46
46
  version: 2.a
@@ -50,7 +50,7 @@ dependencies:
50
50
  requirements:
51
51
  - - ">="
52
52
  - !ruby/object:Gem::Version
53
- version: '0.0'
53
+ version: '0.7'
54
54
  - - "<"
55
55
  - !ruby/object:Gem::Version
56
56
  version: 2.a
@@ -60,7 +60,7 @@ dependencies:
60
60
  requirements:
61
61
  - - ">="
62
62
  - !ruby/object:Gem::Version
63
- version: '0.0'
63
+ version: '0.7'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
208
208
  - !ruby/object:Gem::Version
209
209
  version: '0'
210
210
  requirements: []
211
- rubygems_version: 3.4.19
211
+ rubygems_version: 3.5.3
212
212
  signing_key:
213
213
  specification_version: 4
214
214
  summary: Discovery Engine API.