google-cloud-discovery_engine-v1 0.a → 0.1.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 (91) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +431 -0
  6. data/lib/google/cloud/discovery_engine/v1/completion_service/credentials.rb +47 -0
  7. data/lib/google/cloud/discovery_engine/v1/completion_service/paths.rb +78 -0
  8. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +388 -0
  9. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb +114 -0
  10. data/lib/google/cloud/discovery_engine/v1/completion_service/rest.rb +52 -0
  11. data/lib/google/cloud/discovery_engine/v1/completion_service.rb +55 -0
  12. data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +1155 -0
  13. data/lib/google/cloud/discovery_engine/v1/document_service/credentials.rb +47 -0
  14. data/lib/google/cloud/discovery_engine/v1/document_service/operations.rb +770 -0
  15. data/lib/google/cloud/discovery_engine/v1/document_service/paths.rb +135 -0
  16. data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +956 -0
  17. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +935 -0
  18. data/lib/google/cloud/discovery_engine/v1/document_service/rest/service_stub.rb +518 -0
  19. data/lib/google/cloud/discovery_engine/v1/document_service/rest.rb +54 -0
  20. data/lib/google/cloud/discovery_engine/v1/document_service.rb +57 -0
  21. data/lib/google/cloud/discovery_engine/v1/rest.rb +41 -0
  22. data/lib/google/cloud/discovery_engine/v1/schema_service/client.rb +839 -0
  23. data/lib/google/cloud/discovery_engine/v1/schema_service/credentials.rb +47 -0
  24. data/lib/google/cloud/discovery_engine/v1/schema_service/operations.rb +770 -0
  25. data/lib/google/cloud/discovery_engine/v1/schema_service/paths.rb +127 -0
  26. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/client.rb +679 -0
  27. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +935 -0
  28. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/service_stub.rb +382 -0
  29. data/lib/google/cloud/discovery_engine/v1/schema_service/rest.rb +53 -0
  30. data/lib/google/cloud/discovery_engine/v1/schema_service.rb +56 -0
  31. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +493 -0
  32. data/lib/google/cloud/discovery_engine/v1/search_service/credentials.rb +47 -0
  33. data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +131 -0
  34. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +446 -0
  35. data/lib/google/cloud/discovery_engine/v1/search_service/rest/service_stub.rb +116 -0
  36. data/lib/google/cloud/discovery_engine/v1/search_service/rest.rb +52 -0
  37. data/lib/google/cloud/discovery_engine/v1/search_service.rb +55 -0
  38. data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +640 -0
  39. data/lib/google/cloud/discovery_engine/v1/user_event_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1/user_event_service/operations.rb +770 -0
  41. data/lib/google/cloud/discovery_engine/v1/user_event_service/paths.rb +131 -0
  42. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +544 -0
  43. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +935 -0
  44. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb +250 -0
  45. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest.rb +53 -0
  46. data/lib/google/cloud/discovery_engine/v1/user_event_service.rb +56 -0
  47. data/lib/google/cloud/discovery_engine/v1/version.rb +7 -2
  48. data/lib/google/cloud/discovery_engine/v1.rb +49 -0
  49. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +45 -0
  50. data/lib/google/cloud/discoveryengine/v1/completion_service_pb.rb +49 -0
  51. data/lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb +45 -0
  52. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +48 -0
  53. data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +58 -0
  54. data/lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb +79 -0
  55. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +66 -0
  56. data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +49 -0
  57. data/lib/google/cloud/discoveryengine/v1/schema_pb.rb +47 -0
  58. data/lib/google/cloud/discoveryengine/v1/schema_service_pb.rb +61 -0
  59. data/lib/google/cloud/discoveryengine/v1/schema_service_services_pb.rb +53 -0
  60. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +61 -0
  61. data/lib/google/cloud/discoveryengine/v1/search_service_services_pb.rb +45 -0
  62. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +58 -0
  63. data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +53 -0
  64. data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb +59 -0
  65. data/lib/google-cloud-discovery_engine-v1.rb +21 -0
  66. data/proto_docs/README.md +4 -0
  67. data/proto_docs/google/api/client.rb +381 -0
  68. data/proto_docs/google/api/field_behavior.rb +71 -0
  69. data/proto_docs/google/api/httpbody.rb +80 -0
  70. data/proto_docs/google/api/launch_stage.rb +71 -0
  71. data/proto_docs/google/api/resource.rb +222 -0
  72. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +89 -0
  73. data/proto_docs/google/cloud/discoveryengine/v1/completion_service.rb +98 -0
  74. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +105 -0
  75. data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +180 -0
  76. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +336 -0
  77. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +84 -0
  78. data/proto_docs/google/cloud/discoveryengine/v1/schema.rb +45 -0
  79. data/proto_docs/google/cloud/discoveryengine/v1/schema_service.rb +177 -0
  80. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +294 -0
  81. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +466 -0
  82. data/proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb +64 -0
  83. data/proto_docs/google/longrunning/operations.rb +164 -0
  84. data/proto_docs/google/protobuf/any.rb +144 -0
  85. data/proto_docs/google/protobuf/duration.rb +98 -0
  86. data/proto_docs/google/protobuf/empty.rb +34 -0
  87. data/proto_docs/google/protobuf/struct.rb +96 -0
  88. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  89. data/proto_docs/google/rpc/status.rb +48 -0
  90. data/proto_docs/google/type/date.rb +53 -0
  91. metadata +243 -12
@@ -0,0 +1,446 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/errors"
20
+ require "google/cloud/discoveryengine/v1/search_service_pb"
21
+ require "google/cloud/discovery_engine/v1/search_service/rest/service_stub"
22
+
23
+ module Google
24
+ module Cloud
25
+ module DiscoveryEngine
26
+ module V1
27
+ module SearchService
28
+ module Rest
29
+ ##
30
+ # REST client for the SearchService service.
31
+ #
32
+ # Service for search.
33
+ #
34
+ class Client
35
+ include Paths
36
+
37
+ # @private
38
+ attr_reader :search_service_stub
39
+
40
+ ##
41
+ # Configure the SearchService Client class.
42
+ #
43
+ # See {::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client::Configuration}
44
+ # for a description of the configuration fields.
45
+ #
46
+ # @example
47
+ #
48
+ # # Modify the configuration for all SearchService clients
49
+ # ::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client.configure do |config|
50
+ # config.timeout = 10.0
51
+ # end
52
+ #
53
+ # @yield [config] Configure the Client client.
54
+ # @yieldparam config [Client::Configuration]
55
+ #
56
+ # @return [Client::Configuration]
57
+ #
58
+ def self.configure
59
+ @configure ||= begin
60
+ namespace = ["Google", "Cloud", "DiscoveryEngine", "V1"]
61
+ parent_config = while namespace.any?
62
+ parent_name = namespace.join "::"
63
+ parent_const = const_get parent_name
64
+ break parent_const.configure if parent_const.respond_to? :configure
65
+ namespace.pop
66
+ end
67
+ default_config = Client::Configuration.new parent_config
68
+
69
+ default_config.timeout = 5.0
70
+ default_config.retry_policy = {
71
+ initial_delay: 0.1, max_delay: 5.0, multiplier: 1.3, retry_codes: [14]
72
+ }
73
+
74
+ default_config
75
+ end
76
+ yield @configure if block_given?
77
+ @configure
78
+ end
79
+
80
+ ##
81
+ # Configure the SearchService Client instance.
82
+ #
83
+ # The configuration is set to the derived mode, meaning that values can be changed,
84
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
85
+ # should be made on {Client.configure}.
86
+ #
87
+ # See {::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client::Configuration}
88
+ # for a description of the configuration fields.
89
+ #
90
+ # @yield [config] Configure the Client client.
91
+ # @yieldparam config [Client::Configuration]
92
+ #
93
+ # @return [Client::Configuration]
94
+ #
95
+ def configure
96
+ yield @config if block_given?
97
+ @config
98
+ end
99
+
100
+ ##
101
+ # Create a new SearchService REST client object.
102
+ #
103
+ # @example
104
+ #
105
+ # # Create a client using the default configuration
106
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client.new
107
+ #
108
+ # # Create a client using a custom configuration
109
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client.new do |config|
110
+ # config.timeout = 10.0
111
+ # end
112
+ #
113
+ # @yield [config] Configure the SearchService client.
114
+ # @yieldparam config [Client::Configuration]
115
+ #
116
+ def initialize
117
+ # Create the configuration object
118
+ @config = Configuration.new Client.configure
119
+
120
+ # Yield the configuration if needed
121
+ yield @config if block_given?
122
+
123
+ # Create credentials
124
+ credentials = @config.credentials
125
+ # Use self-signed JWT if the endpoint is unchanged from default,
126
+ # but only if the default endpoint does not have a region prefix.
127
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
128
+ !@config.endpoint.split(".").first.include?("-")
129
+ credentials ||= Credentials.default scope: @config.scope,
130
+ enable_self_signed_jwt: enable_self_signed_jwt
131
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
132
+ credentials = Credentials.new credentials, scope: @config.scope
133
+ end
134
+
135
+ @quota_project_id = @config.quota_project
136
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
137
+
138
+ @search_service_stub = ::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
139
+ end
140
+
141
+ # Service calls
142
+
143
+ ##
144
+ # Performs a search.
145
+ #
146
+ # @overload search(request, options = nil)
147
+ # Pass arguments to `search` via a request object, either of type
148
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest} or an equivalent Hash.
149
+ #
150
+ # @param request [::Google::Cloud::DiscoveryEngine::V1::SearchRequest, ::Hash]
151
+ # A request object representing the call parameters. Required. To specify no
152
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
153
+ # @param options [::Gapic::CallOptions, ::Hash]
154
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
155
+ #
156
+ # @overload search(serving_config: nil, branch: nil, query: nil, page_size: nil, page_token: nil, offset: nil, user_info: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil)
157
+ # Pass arguments to `search` via keyword arguments. Note that at
158
+ # least one keyword argument is required. To specify no parameters, or to keep all
159
+ # the default parameter values, pass an empty Hash as a request object (see above).
160
+ #
161
+ # @param serving_config [::String]
162
+ # Required. The resource name of the Search serving config, such as
163
+ # `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
164
+ # This field is used to identify the serving configuration name, set
165
+ # of models used to make the search.
166
+ # @param branch [::String]
167
+ # The branch resource name, such as
168
+ # `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
169
+ #
170
+ # Use `default_branch` as the branch ID or leave this field empty, to search
171
+ # documents under the default branch.
172
+ # @param query [::String]
173
+ # Raw search query.
174
+ # @param page_size [::Integer]
175
+ # Maximum number of {::Google::Cloud::DiscoveryEngine::V1::Document Document}s to
176
+ # return. If unspecified, defaults to a reasonable value. The maximum allowed
177
+ # value is 100. Values above 100 will be coerced to 100.
178
+ #
179
+ # If this field is negative, an `INVALID_ARGUMENT` is returned.
180
+ # @param page_token [::String]
181
+ # A page token received from a previous
182
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client#search SearchService.Search}
183
+ # call. Provide this to retrieve the subsequent page.
184
+ #
185
+ # When paginating, all other parameters provided to
186
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client#search SearchService.Search}
187
+ # must match the call that provided the page token. Otherwise, an
188
+ # `INVALID_ARGUMENT` error is returned.
189
+ # @param offset [::Integer]
190
+ # A 0-indexed integer that specifies the current offset (that is, starting
191
+ # result location, amongst the
192
+ # {::Google::Cloud::DiscoveryEngine::V1::Document Document}s deemed by the API as
193
+ # relevant) in search results. This field is only considered if
194
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#page_token page_token} is
195
+ # unset.
196
+ #
197
+ # If this field is negative, an `INVALID_ARGUMENT` is returned.
198
+ # @param user_info [::Google::Cloud::DiscoveryEngine::V1::UserInfo, ::Hash]
199
+ # Information about the end user.
200
+ # Highly recommended for analytics. The user_agent string in UserInfo will
201
+ # be used to deduce device_type for analytics.
202
+ # @param params [::Hash{::String => ::Google::Protobuf::Value, ::Hash}]
203
+ # Additional search parameters.
204
+ #
205
+ # For public website search only, supported values are:
206
+ #
207
+ # * `user_country_code`: string. Default empty. If set to non-empty, results
208
+ # are restricted or boosted based on the location provided.
209
+ # * `search_type`: double. Default empty. Enables non-webpage searching
210
+ # depending on the value. The only valid non-default value is 1,
211
+ # which enables image searching.
212
+ # @param query_expansion_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::QueryExpansionSpec, ::Hash]
213
+ # The query expansion specification that specifies the conditions under which
214
+ # query expansion will occur.
215
+ # @param spell_correction_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SpellCorrectionSpec, ::Hash]
216
+ # The spell correction specification that specifies the mode under
217
+ # which spell correction will take effect.
218
+ # @param user_pseudo_id [::String]
219
+ # A unique identifier for tracking visitors. For example, this could be
220
+ # implemented with an HTTP cookie, which should be able to uniquely identify
221
+ # a visitor on a single device. This unique identifier should not change if
222
+ # the visitor logs in or out of the website.
223
+ #
224
+ # This field should NOT have a fixed value such as `unknown_visitor`.
225
+ #
226
+ # This should be the same identifier as
227
+ # {::Google::Cloud::DiscoveryEngine::V1::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
228
+ # and
229
+ # {::Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest#user_pseudo_id CompleteQueryRequest.user_pseudo_id}
230
+ #
231
+ # The field must be a UTF-8 encoded string with a length limit of 128
232
+ # characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
233
+ # @param content_search_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec, ::Hash]
234
+ # The content search spec that configs the desired behavior of content
235
+ # search.
236
+ # @param safe_search [::Boolean]
237
+ # Whether to turn on safe search. This is only supported for
238
+ # [ContentConfig.PUBLIC_WEBSITE][].
239
+ # @param user_labels [::Hash{::String => ::String}]
240
+ # The user labels applied to a resource must meet the following requirements:
241
+ #
242
+ # * Each resource can have multiple labels, up to a maximum of 64.
243
+ # * Each label must be a key-value pair.
244
+ # * Keys have a minimum length of 1 character and a maximum length of 63
245
+ # characters and cannot be empty. Values can be empty and have a maximum
246
+ # length of 63 characters.
247
+ # * Keys and values can contain only lowercase letters, numeric characters,
248
+ # underscores, and dashes. All characters must use UTF-8 encoding, and
249
+ # international characters are allowed.
250
+ # * The key portion of a label must be unique. However, you can use the same
251
+ # key with multiple resources.
252
+ # * Keys must start with a lowercase letter or international character.
253
+ #
254
+ # See [Google Cloud
255
+ # Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
256
+ # for more details.
257
+ # @yield [result, operation] Access the result along with the TransportOperation object
258
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
259
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
260
+ #
261
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
262
+ #
263
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
264
+ def search request, options = nil
265
+ raise ::ArgumentError, "request must be provided" if request.nil?
266
+
267
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::SearchRequest
268
+
269
+ # Converts hash and nil to an options object
270
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
271
+
272
+ # Customize the options with defaults
273
+ call_metadata = @config.rpcs.search.metadata.to_h
274
+
275
+ # Set x-goog-api-client and x-goog-user-project headers
276
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
277
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
278
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
279
+ transports_version_send: [:rest]
280
+
281
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
282
+
283
+ options.apply_defaults timeout: @config.rpcs.search.timeout,
284
+ metadata: call_metadata,
285
+ retry_policy: @config.rpcs.search.retry_policy
286
+
287
+ options.apply_defaults timeout: @config.timeout,
288
+ metadata: @config.metadata,
289
+ retry_policy: @config.retry_policy
290
+
291
+ @search_service_stub.search request, options do |result, operation|
292
+ result = ::Gapic::Rest::PagedEnumerable.new @search_service_stub, :search, "results", request, result, options
293
+ yield result, operation if block_given?
294
+ return result
295
+ end
296
+ rescue ::Gapic::Rest::Error => e
297
+ raise ::Google::Cloud::Error.from_error(e)
298
+ end
299
+
300
+ ##
301
+ # Configuration class for the SearchService REST API.
302
+ #
303
+ # This class represents the configuration for SearchService REST,
304
+ # providing control over timeouts, retry behavior, logging, transport
305
+ # parameters, and other low-level controls. Certain parameters can also be
306
+ # applied individually to specific RPCs. See
307
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client::Configuration::Rpcs}
308
+ # for a list of RPCs that can be configured independently.
309
+ #
310
+ # Configuration can be applied globally to all clients, or to a single client
311
+ # on construction.
312
+ #
313
+ # @example
314
+ #
315
+ # # Modify the global config, setting the timeout for
316
+ # # search to 20 seconds,
317
+ # # and all remaining timeouts to 10 seconds.
318
+ # ::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client.configure do |config|
319
+ # config.timeout = 10.0
320
+ # config.rpcs.search.timeout = 20.0
321
+ # end
322
+ #
323
+ # # Apply the above configuration only to a new client.
324
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client.new do |config|
325
+ # config.timeout = 10.0
326
+ # config.rpcs.search.timeout = 20.0
327
+ # end
328
+ #
329
+ # @!attribute [rw] endpoint
330
+ # The hostname or hostname:port of the service endpoint.
331
+ # Defaults to `"discoveryengine.googleapis.com"`.
332
+ # @return [::String]
333
+ # @!attribute [rw] credentials
334
+ # Credentials to send with calls. You may provide any of the following types:
335
+ # * (`String`) The path to a service account key file in JSON format
336
+ # * (`Hash`) A service account key as a Hash
337
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
338
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
339
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
340
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
341
+ # * (`nil`) indicating no credentials
342
+ # @return [::Object]
343
+ # @!attribute [rw] scope
344
+ # The OAuth scopes
345
+ # @return [::Array<::String>]
346
+ # @!attribute [rw] lib_name
347
+ # The library name as recorded in instrumentation and logging
348
+ # @return [::String]
349
+ # @!attribute [rw] lib_version
350
+ # The library version as recorded in instrumentation and logging
351
+ # @return [::String]
352
+ # @!attribute [rw] timeout
353
+ # The call timeout in seconds.
354
+ # @return [::Numeric]
355
+ # @!attribute [rw] metadata
356
+ # Additional headers to be sent with the call.
357
+ # @return [::Hash{::Symbol=>::String}]
358
+ # @!attribute [rw] retry_policy
359
+ # The retry policy. The value is a hash with the following keys:
360
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
361
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
362
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
363
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
364
+ # trigger a retry.
365
+ # @return [::Hash]
366
+ # @!attribute [rw] quota_project
367
+ # A separate project against which to charge quota.
368
+ # @return [::String]
369
+ #
370
+ class Configuration
371
+ extend ::Gapic::Config
372
+
373
+ DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
374
+
375
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
376
+ config_attr :credentials, nil do |value|
377
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
378
+ allowed.any? { |klass| klass === value }
379
+ end
380
+ config_attr :scope, nil, ::String, ::Array, nil
381
+ config_attr :lib_name, nil, ::String, nil
382
+ config_attr :lib_version, nil, ::String, nil
383
+ config_attr :timeout, nil, ::Numeric, nil
384
+ config_attr :metadata, nil, ::Hash, nil
385
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
386
+ config_attr :quota_project, nil, ::String, nil
387
+
388
+ # @private
389
+ def initialize parent_config = nil
390
+ @parent_config = parent_config unless parent_config.nil?
391
+
392
+ yield self if block_given?
393
+ end
394
+
395
+ ##
396
+ # Configurations for individual RPCs
397
+ # @return [Rpcs]
398
+ #
399
+ def rpcs
400
+ @rpcs ||= begin
401
+ parent_rpcs = nil
402
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
403
+ Rpcs.new parent_rpcs
404
+ end
405
+ end
406
+
407
+ ##
408
+ # Configuration RPC class for the SearchService API.
409
+ #
410
+ # Includes fields providing the configuration for each RPC in this service.
411
+ # Each configuration object is of type `Gapic::Config::Method` and includes
412
+ # the following configuration fields:
413
+ #
414
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
415
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
416
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
417
+ # include the following keys:
418
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
419
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
420
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
421
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
422
+ # trigger a retry.
423
+ #
424
+ class Rpcs
425
+ ##
426
+ # RPC-specific configuration for `search`
427
+ # @return [::Gapic::Config::Method]
428
+ #
429
+ attr_reader :search
430
+
431
+ # @private
432
+ def initialize parent_rpcs = nil
433
+ search_config = parent_rpcs.search if parent_rpcs.respond_to? :search
434
+ @search = ::Gapic::Config::Method.new search_config
435
+
436
+ yield self if block_given?
437
+ end
438
+ end
439
+ end
440
+ end
441
+ end
442
+ end
443
+ end
444
+ end
445
+ end
446
+ end
@@ -0,0 +1,116 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/discoveryengine/v1/search_service_pb"
20
+
21
+ module Google
22
+ module Cloud
23
+ module DiscoveryEngine
24
+ module V1
25
+ module SearchService
26
+ module Rest
27
+ ##
28
+ # REST service stub for the SearchService service.
29
+ # Service stub contains baseline method implementations
30
+ # including transcoding, making the REST call, and deserialing the response.
31
+ #
32
+ class ServiceStub
33
+ def initialize endpoint:, credentials:
34
+ # These require statements are intentionally placed here to initialize
35
+ # the REST modules only when it's required.
36
+ require "gapic/rest"
37
+
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
39
+ numeric_enums: true,
40
+ raise_faraday_errors: false
41
+ end
42
+
43
+ ##
44
+ # Baseline implementation for the search REST call
45
+ #
46
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::SearchRequest]
47
+ # A request object representing the call parameters. Required.
48
+ # @param options [::Gapic::CallOptions]
49
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
50
+ #
51
+ # @yield [result, operation] Access the result along with the TransportOperation object
52
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::SearchResponse]
53
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
54
+ #
55
+ # @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse]
56
+ # A result object deserialized from the server's reply
57
+ def search request_pb, options = nil
58
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
59
+
60
+ verb, uri, query_string_params, body = ServiceStub.transcode_search_request request_pb
61
+ query_string_params = if query_string_params.any?
62
+ query_string_params.to_h { |p| p.split "=", 2 }
63
+ else
64
+ {}
65
+ end
66
+
67
+ response = @client_stub.make_http_request(
68
+ verb,
69
+ uri: uri,
70
+ body: body || "",
71
+ params: query_string_params,
72
+ options: options
73
+ )
74
+ operation = ::Gapic::Rest::TransportOperation.new response
75
+ result = ::Google::Cloud::DiscoveryEngine::V1::SearchResponse.decode_json response.body, ignore_unknown_fields: true
76
+
77
+ yield result, operation if block_given?
78
+ result
79
+ end
80
+
81
+ ##
82
+ # @private
83
+ #
84
+ # GRPC transcoding helper method for the search REST call
85
+ #
86
+ # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::SearchRequest]
87
+ # A request object representing the call parameters. Required.
88
+ # @return [Array(String, [String, nil], Hash{String => String})]
89
+ # Uri, Body, Query string parameters
90
+ def self.transcode_search_request request_pb
91
+ transcoder = Gapic::Rest::GrpcTranscoder.new
92
+ .with_bindings(
93
+ uri_method: :post,
94
+ uri_template: "/v1/{serving_config}:search",
95
+ body: "*",
96
+ matches: [
97
+ ["serving_config", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+/?$}, false]
98
+ ]
99
+ )
100
+ .with_bindings(
101
+ uri_method: :post,
102
+ uri_template: "/v1/{serving_config}:search",
103
+ body: "*",
104
+ matches: [
105
+ ["serving_config", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+/?$}, false]
106
+ ]
107
+ )
108
+ transcoder.transcode request_pb
109
+ end
110
+ end
111
+ end
112
+ end
113
+ end
114
+ end
115
+ end
116
+ end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "gapic/rest"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/discovery_engine/v1/version"
24
+
25
+ require "google/cloud/discovery_engine/v1/search_service/credentials"
26
+ require "google/cloud/discovery_engine/v1/search_service/paths"
27
+ require "google/cloud/discovery_engine/v1/search_service/rest/client"
28
+
29
+ module Google
30
+ module Cloud
31
+ module DiscoveryEngine
32
+ module V1
33
+ ##
34
+ # Service for search.
35
+ #
36
+ # To load this service and instantiate a REST client:
37
+ #
38
+ # require "google/cloud/discovery_engine/v1/search_service/rest"
39
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client.new
40
+ #
41
+ module SearchService
42
+ # Client for the REST transport
43
+ module Rest
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
50
+
51
+ helper_path = ::File.join __dir__, "rest", "helpers.rb"
52
+ require "google/cloud/discovery_engine/v1/search_service/rest/helpers" if ::File.file? helper_path
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/discovery_engine/v1/version"
24
+
25
+ require "google/cloud/discovery_engine/v1/search_service/credentials"
26
+ require "google/cloud/discovery_engine/v1/search_service/paths"
27
+ require "google/cloud/discovery_engine/v1/search_service/client"
28
+ require "google/cloud/discovery_engine/v1/search_service/rest"
29
+
30
+ module Google
31
+ module Cloud
32
+ module DiscoveryEngine
33
+ module V1
34
+ ##
35
+ # Service for search.
36
+ #
37
+ # @example Load this service and instantiate a gRPC client
38
+ #
39
+ # require "google/cloud/discovery_engine/v1/search_service"
40
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SearchService::Client.new
41
+ #
42
+ # @example Load this service and instantiate a REST client
43
+ #
44
+ # require "google/cloud/discovery_engine/v1/search_service/rest"
45
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client.new
46
+ #
47
+ module SearchService
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
53
+
54
+ helper_path = ::File.join __dir__, "search_service", "helpers.rb"
55
+ require "google/cloud/discovery_engine/v1/search_service/helpers" if ::File.file? helper_path