google-apis-discoveryengine_v1beta 0.30.0 → 0.32.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +3865 -1578
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +3 -3
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +1381 -245
- data/lib/google/apis/discoveryengine_v1beta/service.rb +2219 -685
- metadata +6 -6
@@ -32,6 +32,8 @@ module Google
|
|
32
32
|
#
|
33
33
|
# @see https://cloud.google.com/discovery-engine/docs
|
34
34
|
class DiscoveryEngineService < Google::Apis::Core::BaseService
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "https://discoveryengine.$UNIVERSE_DOMAIN$/"
|
36
|
+
|
35
37
|
# @return [String]
|
36
38
|
# API key. Your API key identifies your project and provides you with API access,
|
37
39
|
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
@@ -43,7 +45,7 @@ module Google
|
|
43
45
|
attr_accessor :quota_user
|
44
46
|
|
45
47
|
def initialize
|
46
|
-
super(
|
48
|
+
super(DEFAULT_ENDPOINT_TEMPLATE, '',
|
47
49
|
client_name: 'google-apis-discoveryengine_v1beta',
|
48
50
|
client_version: Google::Apis::DiscoveryengineV1beta::GEM_VERSION)
|
49
51
|
@batch_path = 'batch'
|
@@ -133,10 +135,11 @@ module Google
|
|
133
135
|
# Required. The typeahead input used to fetch suggestions. Maximum length is 128
|
134
136
|
# characters.
|
135
137
|
# @param [String] query_model
|
136
|
-
#
|
137
|
-
#
|
138
|
-
#
|
139
|
-
#
|
138
|
+
# Specifies the autocomplete data model. This overrides any model specified in
|
139
|
+
# the Configuration > Autocomplete section of the Cloud console. Currently
|
140
|
+
# supported values: * `document` - Using suggestions generated from user-
|
141
|
+
# imported documents. * `search-history` - Using suggestions generated from the
|
142
|
+
# past history of SearchService.Search API calls. Do not use it when there is no
|
140
143
|
# traffic for Search API. * `user-event` - Using suggestions generated from user-
|
141
144
|
# imported search events. * `document-completable` - Using suggestions taken
|
142
145
|
# directly from user-imported document fields marked as completable. Default
|
@@ -182,6 +185,245 @@ module Google
|
|
182
185
|
execute_or_queue_command(command, &block)
|
183
186
|
end
|
184
187
|
|
188
|
+
# Creates a DataStore. DataStore is for storing Documents. To serve these
|
189
|
+
# documents for Search, or Recommendation use case, an Engine needs to be
|
190
|
+
# created separately.
|
191
|
+
# @param [String] parent
|
192
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
193
|
+
# location`/collections/`collection``.
|
194
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore] google_cloud_discoveryengine_v1beta_data_store_object
|
195
|
+
# @param [Boolean] create_advanced_site_search
|
196
|
+
# A boolean flag indicating whether user want to directly create an advanced
|
197
|
+
# data store for site search. If the data store is not configured as site search
|
198
|
+
# (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be
|
199
|
+
# ignored.
|
200
|
+
# @param [String] data_store_id
|
201
|
+
# Required. The ID to use for the DataStore, which will become the final
|
202
|
+
# component of the DataStore's resource name. This field must conform to [RFC-
|
203
|
+
# 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
|
204
|
+
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
205
|
+
# @param [String] fields
|
206
|
+
# Selector specifying which fields to include in a partial response.
|
207
|
+
# @param [String] quota_user
|
208
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
209
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
210
|
+
# @param [Google::Apis::RequestOptions] options
|
211
|
+
# Request-specific options
|
212
|
+
#
|
213
|
+
# @yield [result, err] Result & error if block supplied
|
214
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
215
|
+
# @yieldparam err [StandardError] error object if request failed
|
216
|
+
#
|
217
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
218
|
+
#
|
219
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
220
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
221
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
222
|
+
def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1beta_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
223
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/dataStores', options)
|
224
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore::Representation
|
225
|
+
command.request_object = google_cloud_discoveryengine_v1beta_data_store_object
|
226
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
227
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
228
|
+
command.params['parent'] = parent unless parent.nil?
|
229
|
+
command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
|
230
|
+
command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
|
231
|
+
command.query['fields'] = fields unless fields.nil?
|
232
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
233
|
+
execute_or_queue_command(command, &block)
|
234
|
+
end
|
235
|
+
|
236
|
+
# Deletes a DataStore.
|
237
|
+
# @param [String] name
|
238
|
+
# Required. Full resource name of DataStore, such as `projects/`project`/
|
239
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
|
240
|
+
# If the caller does not have permission to delete the DataStore, regardless of
|
241
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned. If the
|
242
|
+
# DataStore to delete does not exist, a NOT_FOUND error is returned.
|
243
|
+
# @param [String] fields
|
244
|
+
# Selector specifying which fields to include in a partial response.
|
245
|
+
# @param [String] quota_user
|
246
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
247
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
248
|
+
# @param [Google::Apis::RequestOptions] options
|
249
|
+
# Request-specific options
|
250
|
+
#
|
251
|
+
# @yield [result, err] Result & error if block supplied
|
252
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
253
|
+
# @yieldparam err [StandardError] error object if request failed
|
254
|
+
#
|
255
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
256
|
+
#
|
257
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
258
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
259
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
260
|
+
def delete_project_location_collection_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
261
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
262
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
263
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
264
|
+
command.params['name'] = name unless name.nil?
|
265
|
+
command.query['fields'] = fields unless fields.nil?
|
266
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
267
|
+
execute_or_queue_command(command, &block)
|
268
|
+
end
|
269
|
+
|
270
|
+
# Gets a DataStore.
|
271
|
+
# @param [String] name
|
272
|
+
# Required. Full resource name of DataStore, such as `projects/`project`/
|
273
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
|
274
|
+
# If the caller does not have permission to access the DataStore, regardless of
|
275
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned. If the
|
276
|
+
# requested DataStore does not exist, a NOT_FOUND error is returned.
|
277
|
+
# @param [String] fields
|
278
|
+
# Selector specifying which fields to include in a partial response.
|
279
|
+
# @param [String] quota_user
|
280
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
281
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
282
|
+
# @param [Google::Apis::RequestOptions] options
|
283
|
+
# Request-specific options
|
284
|
+
#
|
285
|
+
# @yield [result, err] Result & error if block supplied
|
286
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore] parsed result object
|
287
|
+
# @yieldparam err [StandardError] error object if request failed
|
288
|
+
#
|
289
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore]
|
290
|
+
#
|
291
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
292
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
293
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
294
|
+
def get_project_location_collection_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
295
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
296
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore::Representation
|
297
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore
|
298
|
+
command.params['name'] = name unless name.nil?
|
299
|
+
command.query['fields'] = fields unless fields.nil?
|
300
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
301
|
+
execute_or_queue_command(command, &block)
|
302
|
+
end
|
303
|
+
|
304
|
+
# Gets the SiteSearchEngine.
|
305
|
+
# @param [String] name
|
306
|
+
# Required. Resource name of SiteSearchEngine, such as `projects/`project`/
|
307
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/
|
308
|
+
# siteSearchEngine`. If the caller does not have permission to access the [
|
309
|
+
# SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED
|
310
|
+
# error is returned.
|
311
|
+
# @param [String] fields
|
312
|
+
# Selector specifying which fields to include in a partial response.
|
313
|
+
# @param [String] quota_user
|
314
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
315
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
316
|
+
# @param [Google::Apis::RequestOptions] options
|
317
|
+
# Request-specific options
|
318
|
+
#
|
319
|
+
# @yield [result, err] Result & error if block supplied
|
320
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteSearchEngine] parsed result object
|
321
|
+
# @yieldparam err [StandardError] error object if request failed
|
322
|
+
#
|
323
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteSearchEngine]
|
324
|
+
#
|
325
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
326
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
327
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
328
|
+
def get_project_location_collection_data_store_site_search_engine(name, fields: nil, quota_user: nil, options: nil, &block)
|
329
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
330
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteSearchEngine::Representation
|
331
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteSearchEngine
|
332
|
+
command.params['name'] = name unless name.nil?
|
333
|
+
command.query['fields'] = fields unless fields.nil?
|
334
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
335
|
+
execute_or_queue_command(command, &block)
|
336
|
+
end
|
337
|
+
|
338
|
+
# Lists all the DataStores associated with the project.
|
339
|
+
# @param [String] parent
|
340
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
341
|
+
# locations/`location`/collections/`collection_id``. If the caller does not have
|
342
|
+
# permission to list DataStores under this location, regardless of whether or
|
343
|
+
# not this data store exists, a PERMISSION_DENIED error is returned.
|
344
|
+
# @param [String] filter
|
345
|
+
# Filter by solution type. For example: filter = 'solution_type:
|
346
|
+
# SOLUTION_TYPE_SEARCH'
|
347
|
+
# @param [Fixnum] page_size
|
348
|
+
# Maximum number of DataStores to return. If unspecified, defaults to 10. The
|
349
|
+
# maximum allowed value is 50. Values above 50 will be coerced to 50. If this
|
350
|
+
# field is negative, an INVALID_ARGUMENT is returned.
|
351
|
+
# @param [String] page_token
|
352
|
+
# A page token ListDataStoresResponse.next_page_token, received from a previous
|
353
|
+
# DataStoreService.ListDataStores call. Provide this to retrieve the subsequent
|
354
|
+
# page. When paginating, all other parameters provided to DataStoreService.
|
355
|
+
# ListDataStores must match the call that provided the page token. Otherwise, an
|
356
|
+
# INVALID_ARGUMENT error is returned.
|
357
|
+
# @param [String] fields
|
358
|
+
# Selector specifying which fields to include in a partial response.
|
359
|
+
# @param [String] quota_user
|
360
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
361
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
362
|
+
# @param [Google::Apis::RequestOptions] options
|
363
|
+
# Request-specific options
|
364
|
+
#
|
365
|
+
# @yield [result, err] Result & error if block supplied
|
366
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDataStoresResponse] parsed result object
|
367
|
+
# @yieldparam err [StandardError] error object if request failed
|
368
|
+
#
|
369
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDataStoresResponse]
|
370
|
+
#
|
371
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
372
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
373
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
374
|
+
def list_project_location_collection_data_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
375
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/dataStores', options)
|
376
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDataStoresResponse::Representation
|
377
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDataStoresResponse
|
378
|
+
command.params['parent'] = parent unless parent.nil?
|
379
|
+
command.query['filter'] = filter unless filter.nil?
|
380
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
381
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
382
|
+
command.query['fields'] = fields unless fields.nil?
|
383
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
384
|
+
execute_or_queue_command(command, &block)
|
385
|
+
end
|
386
|
+
|
387
|
+
# Updates a DataStore
|
388
|
+
# @param [String] name
|
389
|
+
# Immutable. The full resource name of the data store. Format: `projects/`
|
390
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
391
|
+
# data_store_id``. This field must be a UTF-8 encoded string with a length limit
|
392
|
+
# of 1024 characters.
|
393
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore] google_cloud_discoveryengine_v1beta_data_store_object
|
394
|
+
# @param [String] update_mask
|
395
|
+
# Indicates which fields in the provided DataStore to update. If an unsupported
|
396
|
+
# or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
397
|
+
# @param [String] fields
|
398
|
+
# Selector specifying which fields to include in a partial response.
|
399
|
+
# @param [String] quota_user
|
400
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
401
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
402
|
+
# @param [Google::Apis::RequestOptions] options
|
403
|
+
# Request-specific options
|
404
|
+
#
|
405
|
+
# @yield [result, err] Result & error if block supplied
|
406
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore] parsed result object
|
407
|
+
# @yieldparam err [StandardError] error object if request failed
|
408
|
+
#
|
409
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore]
|
410
|
+
#
|
411
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
412
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
413
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
414
|
+
def patch_project_location_collection_data_store(name, google_cloud_discoveryengine_v1beta_data_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
415
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
416
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore::Representation
|
417
|
+
command.request_object = google_cloud_discoveryengine_v1beta_data_store_object
|
418
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore::Representation
|
419
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore
|
420
|
+
command.params['name'] = name unless name.nil?
|
421
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
422
|
+
command.query['fields'] = fields unless fields.nil?
|
423
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
424
|
+
execute_or_queue_command(command, &block)
|
425
|
+
end
|
426
|
+
|
185
427
|
# Creates a Document.
|
186
428
|
# @param [String] parent
|
187
429
|
# Required. The parent resource name, such as `projects/`project`/locations/`
|
@@ -725,7 +967,7 @@ module Google
|
|
725
967
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
|
726
968
|
# @param [String] update_mask
|
727
969
|
# Indicates which fields in the provided Conversation to update. The following
|
728
|
-
# are NOT supported: *
|
970
|
+
# are NOT supported: * Conversation.name If not set or empty, all supported
|
729
971
|
# fields are updated.
|
730
972
|
# @param [String] fields
|
731
973
|
# Selector specifying which fields to include in a partial response.
|
@@ -1166,7 +1408,7 @@ module Google
|
|
1166
1408
|
# used as the ID of the default serving config. For example, for Engine `
|
1167
1409
|
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
1168
1410
|
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
1169
|
-
# engine` for your Recommend requests.
|
1411
|
+
# engine` for your RecommendationService.Recommend requests.
|
1170
1412
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
1171
1413
|
# @param [String] fields
|
1172
1414
|
# Selector specifying which fields to include in a partial response.
|
@@ -1235,10 +1477,13 @@ module Google
|
|
1235
1477
|
execute_or_queue_command(command, &block)
|
1236
1478
|
end
|
1237
1479
|
|
1238
|
-
#
|
1239
|
-
#
|
1240
|
-
# @param [String]
|
1241
|
-
# The
|
1480
|
+
# Verify target sites' ownership and validity. This API sends all the target
|
1481
|
+
# sites under site search engine for verification.
|
1482
|
+
# @param [String] parent
|
1483
|
+
# Required. The parent resource shared by all TargetSites being verified. `
|
1484
|
+
# projects/`project`/locations/`location`/collections/`collection`/dataStores/`
|
1485
|
+
# data_store`/siteSearchEngine`.
|
1486
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest] google_cloud_discoveryengine_v1beta_batch_verify_target_sites_request_object
|
1242
1487
|
# @param [String] fields
|
1243
1488
|
# Selector specifying which fields to include in a partial response.
|
1244
1489
|
# @param [String] quota_user
|
@@ -1256,26 +1501,23 @@ module Google
|
|
1256
1501
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1257
1502
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1258
1503
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1259
|
-
def
|
1260
|
-
command = make_simple_command(:
|
1504
|
+
def batch_project_location_collection_data_store_site_search_engine_verify_target_sites(parent, google_cloud_discoveryengine_v1beta_batch_verify_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1505
|
+
command = make_simple_command(:post, 'v1beta/{+parent}:batchVerifyTargetSites', options)
|
1506
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest::Representation
|
1507
|
+
command.request_object = google_cloud_discoveryengine_v1beta_batch_verify_target_sites_request_object
|
1261
1508
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1262
1509
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
1263
|
-
command.params['
|
1510
|
+
command.params['parent'] = parent unless parent.nil?
|
1264
1511
|
command.query['fields'] = fields unless fields.nil?
|
1265
1512
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1266
1513
|
execute_or_queue_command(command, &block)
|
1267
1514
|
end
|
1268
1515
|
|
1269
|
-
#
|
1270
|
-
#
|
1271
|
-
#
|
1272
|
-
#
|
1273
|
-
# @param [
|
1274
|
-
# The standard list filter.
|
1275
|
-
# @param [Fixnum] page_size
|
1276
|
-
# The standard list page size.
|
1277
|
-
# @param [String] page_token
|
1278
|
-
# The standard list page token.
|
1516
|
+
# Downgrade from advanced site search to basic site search.
|
1517
|
+
# @param [String] site_search_engine
|
1518
|
+
# Required. Full resource name of the SiteSearchEngine, such as `projects/`
|
1519
|
+
# project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
|
1520
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1beta_disable_advanced_site_search_request_object
|
1279
1521
|
# @param [String] fields
|
1280
1522
|
# Selector specifying which fields to include in a partial response.
|
1281
1523
|
# @param [String] quota_user
|
@@ -1285,31 +1527,31 @@ module Google
|
|
1285
1527
|
# Request-specific options
|
1286
1528
|
#
|
1287
1529
|
# @yield [result, err] Result & error if block supplied
|
1288
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
1530
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
1289
1531
|
# @yieldparam err [StandardError] error object if request failed
|
1290
1532
|
#
|
1291
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
1533
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
1292
1534
|
#
|
1293
1535
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1294
1536
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1295
1537
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1296
|
-
def
|
1297
|
-
command = make_simple_command(:
|
1298
|
-
command.
|
1299
|
-
command.
|
1300
|
-
command.
|
1301
|
-
command.
|
1302
|
-
command.
|
1303
|
-
command.query['pageToken'] = page_token unless page_token.nil?
|
1538
|
+
def disable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1beta_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1539
|
+
command = make_simple_command(:post, 'v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
|
1540
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest::Representation
|
1541
|
+
command.request_object = google_cloud_discoveryengine_v1beta_disable_advanced_site_search_request_object
|
1542
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1543
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
1544
|
+
command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
|
1304
1545
|
command.query['fields'] = fields unless fields.nil?
|
1305
1546
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1306
1547
|
execute_or_queue_command(command, &block)
|
1307
1548
|
end
|
1308
1549
|
|
1309
|
-
#
|
1310
|
-
#
|
1311
|
-
#
|
1312
|
-
#
|
1550
|
+
# Upgrade from basic site search to advanced site search.
|
1551
|
+
# @param [String] site_search_engine
|
1552
|
+
# Required. Full resource name of the SiteSearchEngine, such as `projects/`
|
1553
|
+
# project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
|
1554
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1beta_enable_advanced_site_search_request_object
|
1313
1555
|
# @param [String] fields
|
1314
1556
|
# Selector specifying which fields to include in a partial response.
|
1315
1557
|
# @param [String] quota_user
|
@@ -1327,26 +1569,34 @@ module Google
|
|
1327
1569
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1328
1570
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1329
1571
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1330
|
-
def
|
1331
|
-
command = make_simple_command(:
|
1572
|
+
def enable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1beta_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1573
|
+
command = make_simple_command(:post, 'v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
|
1574
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest::Representation
|
1575
|
+
command.request_object = google_cloud_discoveryengine_v1beta_enable_advanced_site_search_request_object
|
1332
1576
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1333
1577
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
1334
|
-
command.params['
|
1578
|
+
command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
|
1335
1579
|
command.query['fields'] = fields unless fields.nil?
|
1336
1580
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1337
1581
|
execute_or_queue_command(command, &block)
|
1338
1582
|
end
|
1339
1583
|
|
1340
|
-
#
|
1341
|
-
#
|
1342
|
-
# @param [String]
|
1343
|
-
# The
|
1344
|
-
#
|
1345
|
-
#
|
1584
|
+
# Returns list of target sites with its domain verification status. This method
|
1585
|
+
# can only be called under data store with BASIC_SITE_SEARCH state at the moment.
|
1586
|
+
# @param [String] site_search_engine
|
1587
|
+
# Required. The site search engine resource under which we fetch all the domain
|
1588
|
+
# verification status. `projects/`project`/locations/`location`/collections/`
|
1589
|
+
# collection`/dataStores/`data_store`/siteSearchEngine`.
|
1346
1590
|
# @param [Fixnum] page_size
|
1347
|
-
#
|
1591
|
+
# Requested page size. Server may return fewer items than requested. If
|
1592
|
+
# unspecified, server will pick an appropriate default. The maximum value is
|
1593
|
+
# 1000; values above 1000 will be coerced to 1000. If this field is negative, an
|
1594
|
+
# INVALID_ARGUMENT error is returned.
|
1348
1595
|
# @param [String] page_token
|
1349
|
-
#
|
1596
|
+
# A page token, received from a previous `FetchDomainVerificationStatus` call.
|
1597
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
1598
|
+
# parameters provided to `FetchDomainVerificationStatus` must match the call
|
1599
|
+
# that provided the page token.
|
1350
1600
|
# @param [String] fields
|
1351
1601
|
# Selector specifying which fields to include in a partial response.
|
1352
1602
|
# @param [String] quota_user
|
@@ -1356,20 +1606,19 @@ module Google
|
|
1356
1606
|
# Request-specific options
|
1357
1607
|
#
|
1358
1608
|
# @yield [result, err] Result & error if block supplied
|
1359
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
1609
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse] parsed result object
|
1360
1610
|
# @yieldparam err [StandardError] error object if request failed
|
1361
1611
|
#
|
1362
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
1612
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse]
|
1363
1613
|
#
|
1364
1614
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1365
1615
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1366
1616
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1367
|
-
def
|
1368
|
-
command = make_simple_command(:get, 'v1beta/{+
|
1369
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
1370
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
1371
|
-
command.params['
|
1372
|
-
command.query['filter'] = filter unless filter.nil?
|
1617
|
+
def fetch_project_location_collection_data_store_site_search_engine_domain_verification_status(site_search_engine, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1618
|
+
command = make_simple_command(:get, 'v1beta/{+siteSearchEngine}:fetchDomainVerificationStatus', options)
|
1619
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse::Representation
|
1620
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse
|
1621
|
+
command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
|
1373
1622
|
command.query['pageSize'] = page_size unless page_size.nil?
|
1374
1623
|
command.query['pageToken'] = page_token unless page_token.nil?
|
1375
1624
|
command.query['fields'] = fields unless fields.nil?
|
@@ -1377,24 +1626,11 @@ module Google
|
|
1377
1626
|
execute_or_queue_command(command, &block)
|
1378
1627
|
end
|
1379
1628
|
|
1380
|
-
#
|
1381
|
-
#
|
1382
|
-
#
|
1383
|
-
#
|
1384
|
-
# @param [
|
1385
|
-
# Required. The parent DataStore resource name, such as `projects/`project`/
|
1386
|
-
# locations/`location`/collections/`collection`/dataStores/`data_store``.
|
1387
|
-
# @param [Fixnum] ets
|
1388
|
-
# The event timestamp in milliseconds. This prevents browser caching of
|
1389
|
-
# otherwise identical get requests. The name is abbreviated to reduce the
|
1390
|
-
# payload bytes.
|
1391
|
-
# @param [String] uri
|
1392
|
-
# The URL including cgi-parameters but excluding the hash fragment with a length
|
1393
|
-
# limit of 5,000 characters. This is often more useful than the referer URL,
|
1394
|
-
# because many browsers only send the domain for third-party requests.
|
1395
|
-
# @param [String] user_event
|
1396
|
-
# Required. URL encoded UserEvent proto with a length limit of 2,000,000
|
1397
|
-
# characters.
|
1629
|
+
# Request on-demand recrawl for a list of URIs.
|
1630
|
+
# @param [String] site_search_engine
|
1631
|
+
# Required. Full resource name of the SiteSearchEngine, such as `projects/*/
|
1632
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
1633
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest] google_cloud_discoveryengine_v1beta_recrawl_uris_request_object
|
1398
1634
|
# @param [String] fields
|
1399
1635
|
# Selector specifying which fields to include in a partial response.
|
1400
1636
|
# @param [String] quota_user
|
@@ -1404,36 +1640,30 @@ module Google
|
|
1404
1640
|
# Request-specific options
|
1405
1641
|
#
|
1406
1642
|
# @yield [result, err] Result & error if block supplied
|
1407
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
1643
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
1408
1644
|
# @yieldparam err [StandardError] error object if request failed
|
1409
1645
|
#
|
1410
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
1646
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
1411
1647
|
#
|
1412
1648
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1413
1649
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1414
1650
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1415
|
-
def
|
1416
|
-
command = make_simple_command(:
|
1417
|
-
command.
|
1418
|
-
command.
|
1419
|
-
command.
|
1420
|
-
command.
|
1421
|
-
command.
|
1422
|
-
command.query['userEvent'] = user_event unless user_event.nil?
|
1651
|
+
def recrawl_project_location_collection_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1beta_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1652
|
+
command = make_simple_command(:post, 'v1beta/{+siteSearchEngine}:recrawlUris', options)
|
1653
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest::Representation
|
1654
|
+
command.request_object = google_cloud_discoveryengine_v1beta_recrawl_uris_request_object
|
1655
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1656
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
1657
|
+
command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
|
1423
1658
|
command.query['fields'] = fields unless fields.nil?
|
1424
1659
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1425
1660
|
execute_or_queue_command(command, &block)
|
1426
1661
|
end
|
1427
1662
|
|
1428
|
-
#
|
1429
|
-
#
|
1430
|
-
#
|
1431
|
-
#
|
1432
|
-
# metadata is of type ImportMetadata.
|
1433
|
-
# @param [String] parent
|
1434
|
-
# Required. Parent DataStore resource name, of the form `projects/`project`/
|
1435
|
-
# locations/`location`/collections/`collection`/dataStores/`data_store``
|
1436
|
-
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest] google_cloud_discoveryengine_v1beta_import_user_events_request_object
|
1663
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
1664
|
+
# to poll the operation result at intervals as recommended by the API service.
|
1665
|
+
# @param [String] name
|
1666
|
+
# The name of the operation resource.
|
1437
1667
|
# @param [String] fields
|
1438
1668
|
# Selector specifying which fields to include in a partial response.
|
1439
1669
|
# @param [String] quota_user
|
@@ -1451,23 +1681,26 @@ module Google
|
|
1451
1681
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1452
1682
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1453
1683
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1454
|
-
def
|
1455
|
-
command = make_simple_command(:
|
1456
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest::Representation
|
1457
|
-
command.request_object = google_cloud_discoveryengine_v1beta_import_user_events_request_object
|
1684
|
+
def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1685
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
1458
1686
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1459
1687
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
1460
|
-
command.params['
|
1688
|
+
command.params['name'] = name unless name.nil?
|
1461
1689
|
command.query['fields'] = fields unless fields.nil?
|
1462
1690
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1463
1691
|
execute_or_queue_command(command, &block)
|
1464
1692
|
end
|
1465
1693
|
|
1466
|
-
#
|
1467
|
-
#
|
1468
|
-
#
|
1469
|
-
#
|
1470
|
-
# @param [
|
1694
|
+
# Lists operations that match the specified filter in the request. If the server
|
1695
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
1696
|
+
# @param [String] name
|
1697
|
+
# The name of the operation's parent resource.
|
1698
|
+
# @param [String] filter
|
1699
|
+
# The standard list filter.
|
1700
|
+
# @param [Fixnum] page_size
|
1701
|
+
# The standard list page size.
|
1702
|
+
# @param [String] page_token
|
1703
|
+
# The standard list page token.
|
1471
1704
|
# @param [String] fields
|
1472
1705
|
# Selector specifying which fields to include in a partial response.
|
1473
1706
|
# @param [String] quota_user
|
@@ -1477,35 +1710,34 @@ module Google
|
|
1477
1710
|
# Request-specific options
|
1478
1711
|
#
|
1479
1712
|
# @yield [result, err] Result & error if block supplied
|
1480
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
1713
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
1481
1714
|
# @yieldparam err [StandardError] error object if request failed
|
1482
1715
|
#
|
1483
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
1716
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
1484
1717
|
#
|
1485
1718
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1486
1719
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1487
1720
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1488
|
-
def
|
1489
|
-
command = make_simple_command(:
|
1490
|
-
command.
|
1491
|
-
command.
|
1492
|
-
command.
|
1493
|
-
command.
|
1494
|
-
command.
|
1721
|
+
def list_project_location_collection_data_store_site_search_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1722
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
1723
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
1724
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
1725
|
+
command.params['name'] = name unless name.nil?
|
1726
|
+
command.query['filter'] = filter unless filter.nil?
|
1727
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1728
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1495
1729
|
command.query['fields'] = fields unless fields.nil?
|
1496
1730
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1497
1731
|
execute_or_queue_command(command, &block)
|
1498
1732
|
end
|
1499
1733
|
|
1500
|
-
#
|
1501
|
-
# @param [String]
|
1502
|
-
# Required. The resource
|
1503
|
-
#
|
1504
|
-
#
|
1505
|
-
#
|
1506
|
-
#
|
1507
|
-
# new conversation inside a ConverseConversation session.
|
1508
|
-
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest] google_cloud_discoveryengine_v1beta_converse_conversation_request_object
|
1734
|
+
# Creates TargetSite in a batch.
|
1735
|
+
# @param [String] parent
|
1736
|
+
# Required. The parent resource shared by all TargetSites being created. `
|
1737
|
+
# projects/`project`/locations/`location`/collections/`collection`/dataStores/`
|
1738
|
+
# data_store`/siteSearchEngine`. The parent field in the CreateBookRequest
|
1739
|
+
# messages must either be empty or match this field.
|
1740
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest] google_cloud_discoveryengine_v1beta_batch_create_target_sites_request_object
|
1509
1741
|
# @param [String] fields
|
1510
1742
|
# Selector specifying which fields to include in a partial response.
|
1511
1743
|
# @param [String] quota_user
|
@@ -1515,33 +1747,32 @@ module Google
|
|
1515
1747
|
# Request-specific options
|
1516
1748
|
#
|
1517
1749
|
# @yield [result, err] Result & error if block supplied
|
1518
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
1750
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
1519
1751
|
# @yieldparam err [StandardError] error object if request failed
|
1520
1752
|
#
|
1521
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
1753
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
1522
1754
|
#
|
1523
1755
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1524
1756
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1525
1757
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1526
|
-
def
|
1527
|
-
command = make_simple_command(:post, 'v1beta/{+
|
1528
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
1529
|
-
command.request_object =
|
1530
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
1531
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
1532
|
-
command.params['
|
1758
|
+
def batch_project_location_collection_data_store_site_search_engine_target_site_create(parent, google_cloud_discoveryengine_v1beta_batch_create_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1759
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/targetSites:batchCreate', options)
|
1760
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest::Representation
|
1761
|
+
command.request_object = google_cloud_discoveryengine_v1beta_batch_create_target_sites_request_object
|
1762
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1763
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
1764
|
+
command.params['parent'] = parent unless parent.nil?
|
1533
1765
|
command.query['fields'] = fields unless fields.nil?
|
1534
1766
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1535
1767
|
execute_or_queue_command(command, &block)
|
1536
1768
|
end
|
1537
1769
|
|
1538
|
-
# Creates a
|
1539
|
-
# ALREADY_EXISTS error is returned.
|
1770
|
+
# Creates a TargetSite.
|
1540
1771
|
# @param [String] parent
|
1541
|
-
# Required.
|
1542
|
-
#
|
1543
|
-
#
|
1544
|
-
# @param [Google::Apis::DiscoveryengineV1beta::
|
1772
|
+
# Required. Parent resource name of TargetSite, such as `projects/`project`/
|
1773
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/
|
1774
|
+
# siteSearchEngine`.
|
1775
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite] google_cloud_discoveryengine_v1beta_target_site_object
|
1545
1776
|
# @param [String] fields
|
1546
1777
|
# Selector specifying which fields to include in a partial response.
|
1547
1778
|
# @param [String] quota_user
|
@@ -1551,32 +1782,34 @@ module Google
|
|
1551
1782
|
# Request-specific options
|
1552
1783
|
#
|
1553
1784
|
# @yield [result, err] Result & error if block supplied
|
1554
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
1785
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
1555
1786
|
# @yieldparam err [StandardError] error object if request failed
|
1556
1787
|
#
|
1557
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
1788
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
1558
1789
|
#
|
1559
1790
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1560
1791
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1561
1792
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1562
|
-
def
|
1563
|
-
command = make_simple_command(:post, 'v1beta/{+parent}/
|
1564
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
1565
|
-
command.request_object =
|
1566
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
1567
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
1793
|
+
def create_project_location_collection_data_store_site_search_engine_target_site(parent, google_cloud_discoveryengine_v1beta_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1794
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/targetSites', options)
|
1795
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite::Representation
|
1796
|
+
command.request_object = google_cloud_discoveryengine_v1beta_target_site_object
|
1797
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1798
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
1568
1799
|
command.params['parent'] = parent unless parent.nil?
|
1569
1800
|
command.query['fields'] = fields unless fields.nil?
|
1570
1801
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1571
1802
|
execute_or_queue_command(command, &block)
|
1572
1803
|
end
|
1573
1804
|
|
1574
|
-
# Deletes a
|
1575
|
-
# NOT_FOUND error is returned.
|
1805
|
+
# Deletes a TargetSite.
|
1576
1806
|
# @param [String] name
|
1577
|
-
# Required.
|
1578
|
-
#
|
1579
|
-
#
|
1807
|
+
# Required. Full resource name of TargetSite, such as `projects/`project`/
|
1808
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/
|
1809
|
+
# siteSearchEngine/targetSites/`target_site``. If the caller does not have
|
1810
|
+
# permission to access the TargetSite, regardless of whether or not it exists, a
|
1811
|
+
# PERMISSION_DENIED error is returned. If the requested TargetSite does not
|
1812
|
+
# exist, a NOT_FOUND error is returned.
|
1580
1813
|
# @param [String] fields
|
1581
1814
|
# Selector specifying which fields to include in a partial response.
|
1582
1815
|
# @param [String] quota_user
|
@@ -1586,29 +1819,32 @@ module Google
|
|
1586
1819
|
# Request-specific options
|
1587
1820
|
#
|
1588
1821
|
# @yield [result, err] Result & error if block supplied
|
1589
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
1822
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
1590
1823
|
# @yieldparam err [StandardError] error object if request failed
|
1591
1824
|
#
|
1592
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
1825
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
1593
1826
|
#
|
1594
1827
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1595
1828
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1596
1829
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1597
|
-
def
|
1830
|
+
def delete_project_location_collection_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
|
1598
1831
|
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
1599
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
1600
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
1832
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1833
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
1601
1834
|
command.params['name'] = name unless name.nil?
|
1602
1835
|
command.query['fields'] = fields unless fields.nil?
|
1603
1836
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1604
1837
|
execute_or_queue_command(command, &block)
|
1605
1838
|
end
|
1606
1839
|
|
1607
|
-
# Gets a
|
1840
|
+
# Gets a TargetSite.
|
1608
1841
|
# @param [String] name
|
1609
|
-
# Required.
|
1610
|
-
#
|
1611
|
-
#
|
1842
|
+
# Required. Full resource name of TargetSite, such as `projects/`project`/
|
1843
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/
|
1844
|
+
# siteSearchEngine/targetSites/`target_site``. If the caller does not have
|
1845
|
+
# permission to access the TargetSite, regardless of whether or not it exists, a
|
1846
|
+
# PERMISSION_DENIED error is returned. If the requested TargetSite does not
|
1847
|
+
# exist, a NOT_FOUND error is returned.
|
1612
1848
|
# @param [String] fields
|
1613
1849
|
# Selector specifying which fields to include in a partial response.
|
1614
1850
|
# @param [String] quota_user
|
@@ -1618,41 +1854,40 @@ module Google
|
|
1618
1854
|
# Request-specific options
|
1619
1855
|
#
|
1620
1856
|
# @yield [result, err] Result & error if block supplied
|
1621
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
1857
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite] parsed result object
|
1622
1858
|
# @yieldparam err [StandardError] error object if request failed
|
1623
1859
|
#
|
1624
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
1860
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite]
|
1625
1861
|
#
|
1626
1862
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1627
1863
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1628
1864
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1629
|
-
def
|
1865
|
+
def get_project_location_collection_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
|
1630
1866
|
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
1631
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
1632
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
1867
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite::Representation
|
1868
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite
|
1633
1869
|
command.params['name'] = name unless name.nil?
|
1634
1870
|
command.query['fields'] = fields unless fields.nil?
|
1635
1871
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1636
1872
|
execute_or_queue_command(command, &block)
|
1637
1873
|
end
|
1638
1874
|
|
1639
|
-
#
|
1875
|
+
# Gets a list of TargetSites.
|
1640
1876
|
# @param [String] parent
|
1641
|
-
# Required. The
|
1642
|
-
# locations/`
|
1643
|
-
#
|
1644
|
-
#
|
1645
|
-
#
|
1646
|
-
# @param [String] order_by
|
1647
|
-
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
1648
|
-
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
1649
|
-
# create_time` * `conversation_name` Example: "update_time desc" "create_time"
|
1877
|
+
# Required. The parent site search engine resource name, such as `projects/`
|
1878
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
1879
|
+
# siteSearchEngine`. If the caller does not have permission to list TargetSites
|
1880
|
+
# under this site search engine, regardless of whether or not this branch exists,
|
1881
|
+
# a PERMISSION_DENIED error is returned.
|
1650
1882
|
# @param [Fixnum] page_size
|
1651
|
-
#
|
1652
|
-
#
|
1883
|
+
# Requested page size. Server may return fewer items than requested. If
|
1884
|
+
# unspecified, server will pick an appropriate default. The maximum value is
|
1885
|
+
# 1000; values above 1000 will be coerced to 1000. If this field is negative, an
|
1886
|
+
# INVALID_ARGUMENT error is returned.
|
1653
1887
|
# @param [String] page_token
|
1654
|
-
# A page token, received from a previous `
|
1655
|
-
#
|
1888
|
+
# A page token, received from a previous `ListTargetSites` call. Provide this to
|
1889
|
+
# retrieve the subsequent page. When paginating, all other parameters provided
|
1890
|
+
# to `ListTargetSites` must match the call that provided the page token.
|
1656
1891
|
# @param [String] fields
|
1657
1892
|
# Selector specifying which fields to include in a partial response.
|
1658
1893
|
# @param [String] quota_user
|
@@ -1662,21 +1897,19 @@ module Google
|
|
1662
1897
|
# Request-specific options
|
1663
1898
|
#
|
1664
1899
|
# @yield [result, err] Result & error if block supplied
|
1665
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
1900
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListTargetSitesResponse] parsed result object
|
1666
1901
|
# @yieldparam err [StandardError] error object if request failed
|
1667
1902
|
#
|
1668
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
1903
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListTargetSitesResponse]
|
1669
1904
|
#
|
1670
1905
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1671
1906
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1672
1907
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1673
|
-
def
|
1674
|
-
command = make_simple_command(:get, 'v1beta/{+parent}/
|
1675
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
1676
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
1908
|
+
def list_project_location_collection_data_store_site_search_engine_target_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1909
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/targetSites', options)
|
1910
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListTargetSitesResponse::Representation
|
1911
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListTargetSitesResponse
|
1677
1912
|
command.params['parent'] = parent unless parent.nil?
|
1678
|
-
command.query['filter'] = filter unless filter.nil?
|
1679
|
-
command.query['orderBy'] = order_by unless order_by.nil?
|
1680
1913
|
command.query['pageSize'] = page_size unless page_size.nil?
|
1681
1914
|
command.query['pageToken'] = page_token unless page_token.nil?
|
1682
1915
|
command.query['fields'] = fields unless fields.nil?
|
@@ -1684,17 +1917,13 @@ module Google
|
|
1684
1917
|
execute_or_queue_command(command, &block)
|
1685
1918
|
end
|
1686
1919
|
|
1687
|
-
# Updates a
|
1688
|
-
# Conversation to update does not exist, a NOT_FOUND error is returned.
|
1920
|
+
# Updates a TargetSite.
|
1689
1921
|
# @param [String] name
|
1690
|
-
#
|
1691
|
-
# collection`/
|
1692
|
-
#
|
1693
|
-
#
|
1694
|
-
# @param [
|
1695
|
-
# Indicates which fields in the provided Conversation to update. The following
|
1696
|
-
# are NOT supported: * conversation.name If not set or empty, all supported
|
1697
|
-
# fields are updated.
|
1922
|
+
# Output only. The fully qualified resource name of the target site. `projects/`
|
1923
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
1924
|
+
# siteSearchEngine/targetSites/`target_site`` The `target_site_id` is system-
|
1925
|
+
# generated.
|
1926
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite] google_cloud_discoveryengine_v1beta_target_site_object
|
1698
1927
|
# @param [String] fields
|
1699
1928
|
# Selector specifying which fields to include in a partial response.
|
1700
1929
|
# @param [String] quota_user
|
@@ -1704,22 +1933,21 @@ module Google
|
|
1704
1933
|
# Request-specific options
|
1705
1934
|
#
|
1706
1935
|
# @yield [result, err] Result & error if block supplied
|
1707
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
1936
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
1708
1937
|
# @yieldparam err [StandardError] error object if request failed
|
1709
1938
|
#
|
1710
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
1939
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
1711
1940
|
#
|
1712
1941
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1713
1942
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1714
1943
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1715
|
-
def
|
1944
|
+
def patch_project_location_collection_data_store_site_search_engine_target_site(name, google_cloud_discoveryengine_v1beta_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1716
1945
|
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
1717
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
1718
|
-
command.request_object =
|
1719
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
1720
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
1946
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite::Representation
|
1947
|
+
command.request_object = google_cloud_discoveryengine_v1beta_target_site_object
|
1948
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1949
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
1721
1950
|
command.params['name'] = name unless name.nil?
|
1722
|
-
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1723
1951
|
command.query['fields'] = fields unless fields.nil?
|
1724
1952
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1725
1953
|
execute_or_queue_command(command, &block)
|
@@ -1746,7 +1974,7 @@ module Google
|
|
1746
1974
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1747
1975
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1748
1976
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1749
|
-
def
|
1977
|
+
def get_project_location_collection_data_store_site_search_engine_target_site_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1750
1978
|
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
1751
1979
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1752
1980
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
@@ -1783,7 +2011,7 @@ module Google
|
|
1783
2011
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1784
2012
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1785
2013
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1786
|
-
def
|
2014
|
+
def list_project_location_collection_data_store_site_search_engine_target_site_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1787
2015
|
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
1788
2016
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
1789
2017
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
@@ -1796,17 +2024,11 @@ module Google
|
|
1796
2024
|
execute_or_queue_command(command, &block)
|
1797
2025
|
end
|
1798
2026
|
|
1799
|
-
#
|
1800
|
-
# @param [String]
|
1801
|
-
# Required.
|
1802
|
-
#
|
1803
|
-
#
|
1804
|
-
# created along with your recommendation engine creation. The engine ID will be
|
1805
|
-
# used as the ID of the default serving config. For example, for Engine `
|
1806
|
-
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
1807
|
-
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
1808
|
-
# engine` for your Recommend requests.
|
1809
|
-
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
2027
|
+
# Imports all SuggestionDenyListEntry for a DataStore.
|
2028
|
+
# @param [String] parent
|
2029
|
+
# Required. The parent data store resource name for which to import denylist
|
2030
|
+
# entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
|
2031
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest] google_cloud_discoveryengine_v1beta_import_suggestion_deny_list_entries_request_object
|
1810
2032
|
# @param [String] fields
|
1811
2033
|
# Selector specifying which fields to include in a partial response.
|
1812
2034
|
# @param [String] quota_user
|
@@ -1816,35 +2038,31 @@ module Google
|
|
1816
2038
|
# Request-specific options
|
1817
2039
|
#
|
1818
2040
|
# @yield [result, err] Result & error if block supplied
|
1819
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
2041
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
1820
2042
|
# @yieldparam err [StandardError] error object if request failed
|
1821
2043
|
#
|
1822
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
2044
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
1823
2045
|
#
|
1824
2046
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1825
2047
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1826
2048
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1827
|
-
def
|
1828
|
-
command = make_simple_command(:post, 'v1beta/{+
|
1829
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
1830
|
-
command.request_object =
|
1831
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
1832
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
1833
|
-
command.params['
|
2049
|
+
def import_project_location_collection_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1beta_import_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2050
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/suggestionDenyListEntries:import', options)
|
2051
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest::Representation
|
2052
|
+
command.request_object = google_cloud_discoveryengine_v1beta_import_suggestion_deny_list_entries_request_object
|
2053
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2054
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2055
|
+
command.params['parent'] = parent unless parent.nil?
|
1834
2056
|
command.query['fields'] = fields unless fields.nil?
|
1835
2057
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1836
2058
|
execute_or_queue_command(command, &block)
|
1837
2059
|
end
|
1838
2060
|
|
1839
|
-
#
|
1840
|
-
# @param [String]
|
1841
|
-
# Required. The
|
1842
|
-
# locations
|
1843
|
-
#
|
1844
|
-
# default_collection/dataStores/default_data_store/servingConfigs/
|
1845
|
-
# default_serving_config`. This field is used to identify the serving
|
1846
|
-
# configuration name, set of models used to make the search.
|
1847
|
-
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
2061
|
+
# Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
2062
|
+
# @param [String] parent
|
2063
|
+
# Required. The parent data store resource name for which to import denylist
|
2064
|
+
# entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
|
2065
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest] google_cloud_discoveryengine_v1beta_purge_suggestion_deny_list_entries_request_object
|
1848
2066
|
# @param [String] fields
|
1849
2067
|
# Selector specifying which fields to include in a partial response.
|
1850
2068
|
# @param [String] quota_user
|
@@ -1854,30 +2072,44 @@ module Google
|
|
1854
2072
|
# Request-specific options
|
1855
2073
|
#
|
1856
2074
|
# @yield [result, err] Result & error if block supplied
|
1857
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
2075
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
1858
2076
|
# @yieldparam err [StandardError] error object if request failed
|
1859
2077
|
#
|
1860
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
2078
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
1861
2079
|
#
|
1862
2080
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1863
2081
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1864
2082
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1865
|
-
def
|
1866
|
-
command = make_simple_command(:post, 'v1beta/{+
|
1867
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
1868
|
-
command.request_object =
|
1869
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
1870
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
1871
|
-
command.params['
|
2083
|
+
def purge_project_location_collection_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1beta_purge_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2084
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/suggestionDenyListEntries:purge', options)
|
2085
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest::Representation
|
2086
|
+
command.request_object = google_cloud_discoveryengine_v1beta_purge_suggestion_deny_list_entries_request_object
|
2087
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2088
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2089
|
+
command.params['parent'] = parent unless parent.nil?
|
1872
2090
|
command.query['fields'] = fields unless fields.nil?
|
1873
2091
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1874
2092
|
execute_or_queue_command(command, &block)
|
1875
2093
|
end
|
1876
2094
|
|
1877
|
-
#
|
1878
|
-
#
|
1879
|
-
#
|
1880
|
-
#
|
2095
|
+
# Writes a single user event from the browser. This uses a GET request to due to
|
2096
|
+
# browser restriction of POST-ing to a third-party domain. This method is used
|
2097
|
+
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
2098
|
+
# Users should not call this method directly.
|
2099
|
+
# @param [String] parent
|
2100
|
+
# Required. The parent DataStore resource name, such as `projects/`project`/
|
2101
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``.
|
2102
|
+
# @param [Fixnum] ets
|
2103
|
+
# The event timestamp in milliseconds. This prevents browser caching of
|
2104
|
+
# otherwise identical get requests. The name is abbreviated to reduce the
|
2105
|
+
# payload bytes.
|
2106
|
+
# @param [String] uri
|
2107
|
+
# The URL including cgi-parameters but excluding the hash fragment with a length
|
2108
|
+
# limit of 5,000 characters. This is often more useful than the referer URL,
|
2109
|
+
# because many browsers only send the domain for third-party requests.
|
2110
|
+
# @param [String] user_event
|
2111
|
+
# Required. URL encoded UserEvent proto with a length limit of 2,000,000
|
2112
|
+
# characters.
|
1881
2113
|
# @param [String] fields
|
1882
2114
|
# Selector specifying which fields to include in a partial response.
|
1883
2115
|
# @param [String] quota_user
|
@@ -1887,36 +2119,1355 @@ module Google
|
|
1887
2119
|
# Request-specific options
|
1888
2120
|
#
|
1889
2121
|
# @yield [result, err] Result & error if block supplied
|
1890
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
2122
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody] parsed result object
|
1891
2123
|
# @yieldparam err [StandardError] error object if request failed
|
1892
2124
|
#
|
1893
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
2125
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody]
|
1894
2126
|
#
|
1895
2127
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1896
2128
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1897
2129
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1898
|
-
def
|
1899
|
-
command = make_simple_command(:get, 'v1beta/{+
|
1900
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
1901
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
1902
|
-
command.params['
|
2130
|
+
def collect_project_location_collection_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2131
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/userEvents:collect', options)
|
2132
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody::Representation
|
2133
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody
|
2134
|
+
command.params['parent'] = parent unless parent.nil?
|
2135
|
+
command.query['ets'] = ets unless ets.nil?
|
2136
|
+
command.query['uri'] = uri unless uri.nil?
|
2137
|
+
command.query['userEvent'] = user_event unless user_event.nil?
|
1903
2138
|
command.query['fields'] = fields unless fields.nil?
|
1904
2139
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1905
2140
|
execute_or_queue_command(command, &block)
|
1906
2141
|
end
|
1907
2142
|
|
1908
|
-
#
|
1909
|
-
#
|
1910
|
-
#
|
1911
|
-
#
|
1912
|
-
#
|
1913
|
-
#
|
1914
|
-
#
|
1915
|
-
#
|
1916
|
-
# @param [
|
1917
|
-
#
|
1918
|
-
#
|
1919
|
-
#
|
2143
|
+
# Bulk import of User events. Request processing might be synchronous. Events
|
2144
|
+
# that already exist are skipped. Use this method for backfilling historical
|
2145
|
+
# user events. Operation.response is of type ImportResponse. Note that it is
|
2146
|
+
# possible for a subset of the items to be successfully inserted. Operation.
|
2147
|
+
# metadata is of type ImportMetadata.
|
2148
|
+
# @param [String] parent
|
2149
|
+
# Required. Parent DataStore resource name, of the form `projects/`project`/
|
2150
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``
|
2151
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest] google_cloud_discoveryengine_v1beta_import_user_events_request_object
|
2152
|
+
# @param [String] fields
|
2153
|
+
# Selector specifying which fields to include in a partial response.
|
2154
|
+
# @param [String] quota_user
|
2155
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2156
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2157
|
+
# @param [Google::Apis::RequestOptions] options
|
2158
|
+
# Request-specific options
|
2159
|
+
#
|
2160
|
+
# @yield [result, err] Result & error if block supplied
|
2161
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2162
|
+
# @yieldparam err [StandardError] error object if request failed
|
2163
|
+
#
|
2164
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2165
|
+
#
|
2166
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2167
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2168
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2169
|
+
def import_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2170
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:import', options)
|
2171
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest::Representation
|
2172
|
+
command.request_object = google_cloud_discoveryengine_v1beta_import_user_events_request_object
|
2173
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2174
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2175
|
+
command.params['parent'] = parent unless parent.nil?
|
2176
|
+
command.query['fields'] = fields unless fields.nil?
|
2177
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2178
|
+
execute_or_queue_command(command, &block)
|
2179
|
+
end
|
2180
|
+
|
2181
|
+
# Writes a single user event.
|
2182
|
+
# @param [String] parent
|
2183
|
+
# Required. The parent DataStore resource name, such as `projects/`project`/
|
2184
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``.
|
2185
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
|
2186
|
+
# @param [String] fields
|
2187
|
+
# Selector specifying which fields to include in a partial response.
|
2188
|
+
# @param [String] quota_user
|
2189
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2190
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2191
|
+
# @param [Google::Apis::RequestOptions] options
|
2192
|
+
# Request-specific options
|
2193
|
+
#
|
2194
|
+
# @yield [result, err] Result & error if block supplied
|
2195
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] parsed result object
|
2196
|
+
# @yieldparam err [StandardError] error object if request failed
|
2197
|
+
#
|
2198
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent]
|
2199
|
+
#
|
2200
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2201
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2202
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2203
|
+
def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2204
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:write', options)
|
2205
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
|
2206
|
+
command.request_object = google_cloud_discoveryengine_v1beta_user_event_object
|
2207
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
|
2208
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent
|
2209
|
+
command.params['parent'] = parent unless parent.nil?
|
2210
|
+
command.query['fields'] = fields unless fields.nil?
|
2211
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2212
|
+
execute_or_queue_command(command, &block)
|
2213
|
+
end
|
2214
|
+
|
2215
|
+
# Creates a Engine.
|
2216
|
+
# @param [String] parent
|
2217
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
2218
|
+
# location`/collections/`collection``.
|
2219
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine] google_cloud_discoveryengine_v1beta_engine_object
|
2220
|
+
# @param [String] engine_id
|
2221
|
+
# Required. The ID to use for the Engine, which will become the final component
|
2222
|
+
# of the Engine's resource name. This field must conform to [RFC-1034](https://
|
2223
|
+
# tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
|
2224
|
+
# Otherwise, an INVALID_ARGUMENT error is returned.
|
2225
|
+
# @param [String] fields
|
2226
|
+
# Selector specifying which fields to include in a partial response.
|
2227
|
+
# @param [String] quota_user
|
2228
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2229
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2230
|
+
# @param [Google::Apis::RequestOptions] options
|
2231
|
+
# Request-specific options
|
2232
|
+
#
|
2233
|
+
# @yield [result, err] Result & error if block supplied
|
2234
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2235
|
+
# @yieldparam err [StandardError] error object if request failed
|
2236
|
+
#
|
2237
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2238
|
+
#
|
2239
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2240
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2241
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2242
|
+
def create_project_location_collection_engine(parent, google_cloud_discoveryengine_v1beta_engine_object = nil, engine_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2243
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/engines', options)
|
2244
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine::Representation
|
2245
|
+
command.request_object = google_cloud_discoveryengine_v1beta_engine_object
|
2246
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2247
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2248
|
+
command.params['parent'] = parent unless parent.nil?
|
2249
|
+
command.query['engineId'] = engine_id unless engine_id.nil?
|
2250
|
+
command.query['fields'] = fields unless fields.nil?
|
2251
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2252
|
+
execute_or_queue_command(command, &block)
|
2253
|
+
end
|
2254
|
+
|
2255
|
+
# Deletes a Engine.
|
2256
|
+
# @param [String] name
|
2257
|
+
# Required. Full resource name of Engine, such as `projects/`project`/locations/`
|
2258
|
+
# location`/collections/`collection_id`/engines/`engine_id``. If the caller does
|
2259
|
+
# not have permission to delete the Engine, regardless of whether or not it
|
2260
|
+
# exists, a PERMISSION_DENIED error is returned. If the Engine to delete does
|
2261
|
+
# not exist, a NOT_FOUND error is returned.
|
2262
|
+
# @param [String] fields
|
2263
|
+
# Selector specifying which fields to include in a partial response.
|
2264
|
+
# @param [String] quota_user
|
2265
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2266
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2267
|
+
# @param [Google::Apis::RequestOptions] options
|
2268
|
+
# Request-specific options
|
2269
|
+
#
|
2270
|
+
# @yield [result, err] Result & error if block supplied
|
2271
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2272
|
+
# @yieldparam err [StandardError] error object if request failed
|
2273
|
+
#
|
2274
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2275
|
+
#
|
2276
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2277
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2278
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2279
|
+
def delete_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil, &block)
|
2280
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
2281
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2282
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2283
|
+
command.params['name'] = name unless name.nil?
|
2284
|
+
command.query['fields'] = fields unless fields.nil?
|
2285
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2286
|
+
execute_or_queue_command(command, &block)
|
2287
|
+
end
|
2288
|
+
|
2289
|
+
# Gets a Engine.
|
2290
|
+
# @param [String] name
|
2291
|
+
# Required. Full resource name of Engine, such as `projects/`project`/locations/`
|
2292
|
+
# location`/collections/`collection_id`/engines/`engine_id``.
|
2293
|
+
# @param [String] fields
|
2294
|
+
# Selector specifying which fields to include in a partial response.
|
2295
|
+
# @param [String] quota_user
|
2296
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2297
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2298
|
+
# @param [Google::Apis::RequestOptions] options
|
2299
|
+
# Request-specific options
|
2300
|
+
#
|
2301
|
+
# @yield [result, err] Result & error if block supplied
|
2302
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine] parsed result object
|
2303
|
+
# @yieldparam err [StandardError] error object if request failed
|
2304
|
+
#
|
2305
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine]
|
2306
|
+
#
|
2307
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2308
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2309
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2310
|
+
def get_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil, &block)
|
2311
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
2312
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine::Representation
|
2313
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine
|
2314
|
+
command.params['name'] = name unless name.nil?
|
2315
|
+
command.query['fields'] = fields unless fields.nil?
|
2316
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2317
|
+
execute_or_queue_command(command, &block)
|
2318
|
+
end
|
2319
|
+
|
2320
|
+
# Lists all the Engines associated with the project.
|
2321
|
+
# @param [String] parent
|
2322
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
2323
|
+
# location`/collections/`collection_id``.
|
2324
|
+
# @param [String] filter
|
2325
|
+
# Optional. Filter by solution type. For example: solution_type=
|
2326
|
+
# SOLUTION_TYPE_SEARCH
|
2327
|
+
# @param [Fixnum] page_size
|
2328
|
+
# Optional. Not supported.
|
2329
|
+
# @param [String] page_token
|
2330
|
+
# Optional. Not supported.
|
2331
|
+
# @param [String] fields
|
2332
|
+
# Selector specifying which fields to include in a partial response.
|
2333
|
+
# @param [String] quota_user
|
2334
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2335
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2336
|
+
# @param [Google::Apis::RequestOptions] options
|
2337
|
+
# Request-specific options
|
2338
|
+
#
|
2339
|
+
# @yield [result, err] Result & error if block supplied
|
2340
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEnginesResponse] parsed result object
|
2341
|
+
# @yieldparam err [StandardError] error object if request failed
|
2342
|
+
#
|
2343
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEnginesResponse]
|
2344
|
+
#
|
2345
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2346
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2347
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2348
|
+
def list_project_location_collection_engines(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2349
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/engines', options)
|
2350
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEnginesResponse::Representation
|
2351
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEnginesResponse
|
2352
|
+
command.params['parent'] = parent unless parent.nil?
|
2353
|
+
command.query['filter'] = filter unless filter.nil?
|
2354
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2355
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2356
|
+
command.query['fields'] = fields unless fields.nil?
|
2357
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2358
|
+
execute_or_queue_command(command, &block)
|
2359
|
+
end
|
2360
|
+
|
2361
|
+
# Updates an Engine
|
2362
|
+
# @param [String] name
|
2363
|
+
# Immutable. The fully qualified resource name of the engine. This field must be
|
2364
|
+
# a UTF-8 encoded string with a length limit of 1024 characters. Format: `
|
2365
|
+
# projects/`project_number`/locations/`location`/collections/`collection`/
|
2366
|
+
# engines/`engine`` engine should be 1-63 characters, and valid characters are /
|
2367
|
+
# a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
|
2368
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine] google_cloud_discoveryengine_v1beta_engine_object
|
2369
|
+
# @param [String] update_mask
|
2370
|
+
# Indicates which fields in the provided Engine to update. If an unsupported or
|
2371
|
+
# unknown field is provided, an INVALID_ARGUMENT error is returned.
|
2372
|
+
# @param [String] fields
|
2373
|
+
# Selector specifying which fields to include in a partial response.
|
2374
|
+
# @param [String] quota_user
|
2375
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2376
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2377
|
+
# @param [Google::Apis::RequestOptions] options
|
2378
|
+
# Request-specific options
|
2379
|
+
#
|
2380
|
+
# @yield [result, err] Result & error if block supplied
|
2381
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine] parsed result object
|
2382
|
+
# @yieldparam err [StandardError] error object if request failed
|
2383
|
+
#
|
2384
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine]
|
2385
|
+
#
|
2386
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2387
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2388
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2389
|
+
def patch_project_location_collection_engine(name, google_cloud_discoveryengine_v1beta_engine_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2390
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
2391
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine::Representation
|
2392
|
+
command.request_object = google_cloud_discoveryengine_v1beta_engine_object
|
2393
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine::Representation
|
2394
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine
|
2395
|
+
command.params['name'] = name unless name.nil?
|
2396
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2397
|
+
command.query['fields'] = fields unless fields.nil?
|
2398
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2399
|
+
execute_or_queue_command(command, &block)
|
2400
|
+
end
|
2401
|
+
|
2402
|
+
# Converses a conversation.
|
2403
|
+
# @param [String] name
|
2404
|
+
# Required. The resource name of the Conversation to get. Format: `projects/`
|
2405
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
2406
|
+
# data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
|
2407
|
+
# /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
|
2408
|
+
# conversations/-` to activate auto session mode, which automatically creates a
|
2409
|
+
# new conversation inside a ConverseConversation session.
|
2410
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest] google_cloud_discoveryengine_v1beta_converse_conversation_request_object
|
2411
|
+
# @param [String] fields
|
2412
|
+
# Selector specifying which fields to include in a partial response.
|
2413
|
+
# @param [String] quota_user
|
2414
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2415
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2416
|
+
# @param [Google::Apis::RequestOptions] options
|
2417
|
+
# Request-specific options
|
2418
|
+
#
|
2419
|
+
# @yield [result, err] Result & error if block supplied
|
2420
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse] parsed result object
|
2421
|
+
# @yieldparam err [StandardError] error object if request failed
|
2422
|
+
#
|
2423
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse]
|
2424
|
+
#
|
2425
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2426
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2427
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2428
|
+
def converse_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1beta_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2429
|
+
command = make_simple_command(:post, 'v1beta/{+name}:converse', options)
|
2430
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest::Representation
|
2431
|
+
command.request_object = google_cloud_discoveryengine_v1beta_converse_conversation_request_object
|
2432
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse::Representation
|
2433
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse
|
2434
|
+
command.params['name'] = name unless name.nil?
|
2435
|
+
command.query['fields'] = fields unless fields.nil?
|
2436
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2437
|
+
execute_or_queue_command(command, &block)
|
2438
|
+
end
|
2439
|
+
|
2440
|
+
# Creates a Conversation. If the Conversation to create already exists, an
|
2441
|
+
# ALREADY_EXISTS error is returned.
|
2442
|
+
# @param [String] parent
|
2443
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
2444
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
2445
|
+
# data_store_id``
|
2446
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
|
2447
|
+
# @param [String] fields
|
2448
|
+
# Selector specifying which fields to include in a partial response.
|
2449
|
+
# @param [String] quota_user
|
2450
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2451
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2452
|
+
# @param [Google::Apis::RequestOptions] options
|
2453
|
+
# Request-specific options
|
2454
|
+
#
|
2455
|
+
# @yield [result, err] Result & error if block supplied
|
2456
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
|
2457
|
+
# @yieldparam err [StandardError] error object if request failed
|
2458
|
+
#
|
2459
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
|
2460
|
+
#
|
2461
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2462
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2463
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2464
|
+
def create_project_location_collection_engine_conversation(parent, google_cloud_discoveryengine_v1beta_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2465
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/conversations', options)
|
2466
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
2467
|
+
command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
|
2468
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
2469
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
|
2470
|
+
command.params['parent'] = parent unless parent.nil?
|
2471
|
+
command.query['fields'] = fields unless fields.nil?
|
2472
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2473
|
+
execute_or_queue_command(command, &block)
|
2474
|
+
end
|
2475
|
+
|
2476
|
+
# Deletes a Conversation. If the Conversation to delete does not exist, a
|
2477
|
+
# NOT_FOUND error is returned.
|
2478
|
+
# @param [String] name
|
2479
|
+
# Required. The resource name of the Conversation to delete. Format: `projects/`
|
2480
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
2481
|
+
# data_store_id`/conversations/`conversation_id``
|
2482
|
+
# @param [String] fields
|
2483
|
+
# Selector specifying which fields to include in a partial response.
|
2484
|
+
# @param [String] quota_user
|
2485
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2486
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2487
|
+
# @param [Google::Apis::RequestOptions] options
|
2488
|
+
# Request-specific options
|
2489
|
+
#
|
2490
|
+
# @yield [result, err] Result & error if block supplied
|
2491
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
2492
|
+
# @yieldparam err [StandardError] error object if request failed
|
2493
|
+
#
|
2494
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
2495
|
+
#
|
2496
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2497
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2498
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2499
|
+
def delete_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2500
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
2501
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
2502
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
2503
|
+
command.params['name'] = name unless name.nil?
|
2504
|
+
command.query['fields'] = fields unless fields.nil?
|
2505
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2506
|
+
execute_or_queue_command(command, &block)
|
2507
|
+
end
|
2508
|
+
|
2509
|
+
# Gets a Conversation.
|
2510
|
+
# @param [String] name
|
2511
|
+
# Required. The resource name of the Conversation to get. Format: `projects/`
|
2512
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
2513
|
+
# data_store_id`/conversations/`conversation_id``
|
2514
|
+
# @param [String] fields
|
2515
|
+
# Selector specifying which fields to include in a partial response.
|
2516
|
+
# @param [String] quota_user
|
2517
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2518
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2519
|
+
# @param [Google::Apis::RequestOptions] options
|
2520
|
+
# Request-specific options
|
2521
|
+
#
|
2522
|
+
# @yield [result, err] Result & error if block supplied
|
2523
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
|
2524
|
+
# @yieldparam err [StandardError] error object if request failed
|
2525
|
+
#
|
2526
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
|
2527
|
+
#
|
2528
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2529
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2530
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2531
|
+
def get_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2532
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
2533
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
2534
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
|
2535
|
+
command.params['name'] = name unless name.nil?
|
2536
|
+
command.query['fields'] = fields unless fields.nil?
|
2537
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2538
|
+
execute_or_queue_command(command, &block)
|
2539
|
+
end
|
2540
|
+
|
2541
|
+
# Lists all Conversations by their parent DataStore.
|
2542
|
+
# @param [String] parent
|
2543
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
2544
|
+
# locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
|
2545
|
+
# @param [String] filter
|
2546
|
+
# A filter to apply on the list results. The supported features are:
|
2547
|
+
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
2548
|
+
# @param [String] order_by
|
2549
|
+
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
2550
|
+
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
2551
|
+
# create_time` * `conversation_name` Example: "update_time desc" "create_time"
|
2552
|
+
# @param [Fixnum] page_size
|
2553
|
+
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
2554
|
+
# allowed value is 1000.
|
2555
|
+
# @param [String] page_token
|
2556
|
+
# A page token, received from a previous `ListConversations` call. Provide this
|
2557
|
+
# to retrieve the subsequent page.
|
2558
|
+
# @param [String] fields
|
2559
|
+
# Selector specifying which fields to include in a partial response.
|
2560
|
+
# @param [String] quota_user
|
2561
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2562
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2563
|
+
# @param [Google::Apis::RequestOptions] options
|
2564
|
+
# Request-specific options
|
2565
|
+
#
|
2566
|
+
# @yield [result, err] Result & error if block supplied
|
2567
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse] parsed result object
|
2568
|
+
# @yieldparam err [StandardError] error object if request failed
|
2569
|
+
#
|
2570
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse]
|
2571
|
+
#
|
2572
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2573
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2574
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2575
|
+
def list_project_location_collection_engine_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2576
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/conversations', options)
|
2577
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse::Representation
|
2578
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse
|
2579
|
+
command.params['parent'] = parent unless parent.nil?
|
2580
|
+
command.query['filter'] = filter unless filter.nil?
|
2581
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
2582
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2583
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2584
|
+
command.query['fields'] = fields unless fields.nil?
|
2585
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2586
|
+
execute_or_queue_command(command, &block)
|
2587
|
+
end
|
2588
|
+
|
2589
|
+
# Updates a Conversation. Conversation action type cannot be changed. If the
|
2590
|
+
# Conversation to update does not exist, a NOT_FOUND error is returned.
|
2591
|
+
# @param [String] name
|
2592
|
+
# Immutable. Fully qualified name `project/*/locations/global/collections/`
|
2593
|
+
# collection`/dataStore/*/conversations/*` or `project/*/locations/global/
|
2594
|
+
# collections/`collection`/engines/*/conversations/*`.
|
2595
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
|
2596
|
+
# @param [String] update_mask
|
2597
|
+
# Indicates which fields in the provided Conversation to update. The following
|
2598
|
+
# are NOT supported: * Conversation.name If not set or empty, all supported
|
2599
|
+
# fields are updated.
|
2600
|
+
# @param [String] fields
|
2601
|
+
# Selector specifying which fields to include in a partial response.
|
2602
|
+
# @param [String] quota_user
|
2603
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2604
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2605
|
+
# @param [Google::Apis::RequestOptions] options
|
2606
|
+
# Request-specific options
|
2607
|
+
#
|
2608
|
+
# @yield [result, err] Result & error if block supplied
|
2609
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
|
2610
|
+
# @yieldparam err [StandardError] error object if request failed
|
2611
|
+
#
|
2612
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
|
2613
|
+
#
|
2614
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2615
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2616
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2617
|
+
def patch_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1beta_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2618
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
2619
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
2620
|
+
command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
|
2621
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
2622
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
|
2623
|
+
command.params['name'] = name unless name.nil?
|
2624
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2625
|
+
command.query['fields'] = fields unless fields.nil?
|
2626
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2627
|
+
execute_or_queue_command(command, &block)
|
2628
|
+
end
|
2629
|
+
|
2630
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
2631
|
+
# to poll the operation result at intervals as recommended by the API service.
|
2632
|
+
# @param [String] name
|
2633
|
+
# The name of the operation resource.
|
2634
|
+
# @param [String] fields
|
2635
|
+
# Selector specifying which fields to include in a partial response.
|
2636
|
+
# @param [String] quota_user
|
2637
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2638
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2639
|
+
# @param [Google::Apis::RequestOptions] options
|
2640
|
+
# Request-specific options
|
2641
|
+
#
|
2642
|
+
# @yield [result, err] Result & error if block supplied
|
2643
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2644
|
+
# @yieldparam err [StandardError] error object if request failed
|
2645
|
+
#
|
2646
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2647
|
+
#
|
2648
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2649
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2650
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2651
|
+
def get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2652
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
2653
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2654
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2655
|
+
command.params['name'] = name unless name.nil?
|
2656
|
+
command.query['fields'] = fields unless fields.nil?
|
2657
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2658
|
+
execute_or_queue_command(command, &block)
|
2659
|
+
end
|
2660
|
+
|
2661
|
+
# Lists operations that match the specified filter in the request. If the server
|
2662
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
2663
|
+
# @param [String] name
|
2664
|
+
# The name of the operation's parent resource.
|
2665
|
+
# @param [String] filter
|
2666
|
+
# The standard list filter.
|
2667
|
+
# @param [Fixnum] page_size
|
2668
|
+
# The standard list page size.
|
2669
|
+
# @param [String] page_token
|
2670
|
+
# The standard list page token.
|
2671
|
+
# @param [String] fields
|
2672
|
+
# Selector specifying which fields to include in a partial response.
|
2673
|
+
# @param [String] quota_user
|
2674
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2675
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2676
|
+
# @param [Google::Apis::RequestOptions] options
|
2677
|
+
# Request-specific options
|
2678
|
+
#
|
2679
|
+
# @yield [result, err] Result & error if block supplied
|
2680
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
2681
|
+
# @yieldparam err [StandardError] error object if request failed
|
2682
|
+
#
|
2683
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
2684
|
+
#
|
2685
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2686
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2687
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2688
|
+
def list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2689
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
2690
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
2691
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
2692
|
+
command.params['name'] = name unless name.nil?
|
2693
|
+
command.query['filter'] = filter unless filter.nil?
|
2694
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2695
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2696
|
+
command.query['fields'] = fields unless fields.nil?
|
2697
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2698
|
+
execute_or_queue_command(command, &block)
|
2699
|
+
end
|
2700
|
+
|
2701
|
+
# Makes a recommendation, which requires a contextual user event.
|
2702
|
+
# @param [String] serving_config
|
2703
|
+
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
2704
|
+
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
2705
|
+
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
2706
|
+
# created along with your recommendation engine creation. The engine ID will be
|
2707
|
+
# used as the ID of the default serving config. For example, for Engine `
|
2708
|
+
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
2709
|
+
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
2710
|
+
# engine` for your RecommendationService.Recommend requests.
|
2711
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
2712
|
+
# @param [String] fields
|
2713
|
+
# Selector specifying which fields to include in a partial response.
|
2714
|
+
# @param [String] quota_user
|
2715
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2716
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2717
|
+
# @param [Google::Apis::RequestOptions] options
|
2718
|
+
# Request-specific options
|
2719
|
+
#
|
2720
|
+
# @yield [result, err] Result & error if block supplied
|
2721
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse] parsed result object
|
2722
|
+
# @yieldparam err [StandardError] error object if request failed
|
2723
|
+
#
|
2724
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse]
|
2725
|
+
#
|
2726
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2727
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2728
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2729
|
+
def recommend_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1beta_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2730
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:recommend', options)
|
2731
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest::Representation
|
2732
|
+
command.request_object = google_cloud_discoveryengine_v1beta_recommend_request_object
|
2733
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse::Representation
|
2734
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse
|
2735
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
2736
|
+
command.query['fields'] = fields unless fields.nil?
|
2737
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2738
|
+
execute_or_queue_command(command, &block)
|
2739
|
+
end
|
2740
|
+
|
2741
|
+
# Performs a search.
|
2742
|
+
# @param [String] serving_config
|
2743
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
2744
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
2745
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
2746
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
2747
|
+
# default_serving_config`. This field is used to identify the serving
|
2748
|
+
# configuration name, set of models used to make the search.
|
2749
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
2750
|
+
# @param [String] fields
|
2751
|
+
# Selector specifying which fields to include in a partial response.
|
2752
|
+
# @param [String] quota_user
|
2753
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2754
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2755
|
+
# @param [Google::Apis::RequestOptions] options
|
2756
|
+
# Request-specific options
|
2757
|
+
#
|
2758
|
+
# @yield [result, err] Result & error if block supplied
|
2759
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse] parsed result object
|
2760
|
+
# @yieldparam err [StandardError] error object if request failed
|
2761
|
+
#
|
2762
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse]
|
2763
|
+
#
|
2764
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2765
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2766
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2767
|
+
def search_project_location_collection_engine_serving_configs(serving_config, google_cloud_discoveryengine_v1beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2768
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:search', options)
|
2769
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest::Representation
|
2770
|
+
command.request_object = google_cloud_discoveryengine_v1beta_search_request_object
|
2771
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse::Representation
|
2772
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
|
2773
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
2774
|
+
command.query['fields'] = fields unless fields.nil?
|
2775
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2776
|
+
execute_or_queue_command(command, &block)
|
2777
|
+
end
|
2778
|
+
|
2779
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
2780
|
+
# to poll the operation result at intervals as recommended by the API service.
|
2781
|
+
# @param [String] name
|
2782
|
+
# The name of the operation resource.
|
2783
|
+
# @param [String] fields
|
2784
|
+
# Selector specifying which fields to include in a partial response.
|
2785
|
+
# @param [String] quota_user
|
2786
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2787
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2788
|
+
# @param [Google::Apis::RequestOptions] options
|
2789
|
+
# Request-specific options
|
2790
|
+
#
|
2791
|
+
# @yield [result, err] Result & error if block supplied
|
2792
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2793
|
+
# @yieldparam err [StandardError] error object if request failed
|
2794
|
+
#
|
2795
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2796
|
+
#
|
2797
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2798
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2799
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2800
|
+
def get_project_location_collection_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2801
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
2802
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2803
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2804
|
+
command.params['name'] = name unless name.nil?
|
2805
|
+
command.query['fields'] = fields unless fields.nil?
|
2806
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2807
|
+
execute_or_queue_command(command, &block)
|
2808
|
+
end
|
2809
|
+
|
2810
|
+
# Lists operations that match the specified filter in the request. If the server
|
2811
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
2812
|
+
# @param [String] name
|
2813
|
+
# The name of the operation's parent resource.
|
2814
|
+
# @param [String] filter
|
2815
|
+
# The standard list filter.
|
2816
|
+
# @param [Fixnum] page_size
|
2817
|
+
# The standard list page size.
|
2818
|
+
# @param [String] page_token
|
2819
|
+
# The standard list page token.
|
2820
|
+
# @param [String] fields
|
2821
|
+
# Selector specifying which fields to include in a partial response.
|
2822
|
+
# @param [String] quota_user
|
2823
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2824
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2825
|
+
# @param [Google::Apis::RequestOptions] options
|
2826
|
+
# Request-specific options
|
2827
|
+
#
|
2828
|
+
# @yield [result, err] Result & error if block supplied
|
2829
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
2830
|
+
# @yieldparam err [StandardError] error object if request failed
|
2831
|
+
#
|
2832
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
2833
|
+
#
|
2834
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2835
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2836
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2837
|
+
def list_project_location_collection_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2838
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
2839
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
2840
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
2841
|
+
command.params['name'] = name unless name.nil?
|
2842
|
+
command.query['filter'] = filter unless filter.nil?
|
2843
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2844
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2845
|
+
command.query['fields'] = fields unless fields.nil?
|
2846
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2847
|
+
execute_or_queue_command(command, &block)
|
2848
|
+
end
|
2849
|
+
|
2850
|
+
# Completes the specified user input with keyword suggestions.
|
2851
|
+
# @param [String] data_store
|
2852
|
+
# Required. The parent data store resource name for which the completion is
|
2853
|
+
# performed, such as `projects/*/locations/global/collections/default_collection/
|
2854
|
+
# dataStores/default_data_store`.
|
2855
|
+
# @param [Boolean] include_tail_suggestions
|
2856
|
+
# Indicates if tail suggestions should be returned if there are no suggestions
|
2857
|
+
# that match the full query. Even if set to true, if there are suggestions that
|
2858
|
+
# match the full query, those are returned and no tail suggestions are returned.
|
2859
|
+
# @param [String] query
|
2860
|
+
# Required. The typeahead input used to fetch suggestions. Maximum length is 128
|
2861
|
+
# characters.
|
2862
|
+
# @param [String] query_model
|
2863
|
+
# Specifies the autocomplete data model. This overrides any model specified in
|
2864
|
+
# the Configuration > Autocomplete section of the Cloud console. Currently
|
2865
|
+
# supported values: * `document` - Using suggestions generated from user-
|
2866
|
+
# imported documents. * `search-history` - Using suggestions generated from the
|
2867
|
+
# past history of SearchService.Search API calls. Do not use it when there is no
|
2868
|
+
# traffic for Search API. * `user-event` - Using suggestions generated from user-
|
2869
|
+
# imported search events. * `document-completable` - Using suggestions taken
|
2870
|
+
# directly from user-imported document fields marked as completable. Default
|
2871
|
+
# values: * `document` is the default model for regular dataStores. * `search-
|
2872
|
+
# history` is the default model for site search dataStores.
|
2873
|
+
# @param [String] user_pseudo_id
|
2874
|
+
# A unique identifier for tracking visitors. For example, this could be
|
2875
|
+
# implemented with an HTTP cookie, which should be able to uniquely identify a
|
2876
|
+
# visitor on a single device. This unique identifier should not change if the
|
2877
|
+
# visitor logs in or out of the website. This field should NOT have a fixed
|
2878
|
+
# value such as `unknown_visitor`. This should be the same identifier as
|
2879
|
+
# UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
|
2880
|
+
# UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `
|
2881
|
+
# INVALID_ARGUMENT` error is returned.
|
2882
|
+
# @param [String] fields
|
2883
|
+
# Selector specifying which fields to include in a partial response.
|
2884
|
+
# @param [String] quota_user
|
2885
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2886
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2887
|
+
# @param [Google::Apis::RequestOptions] options
|
2888
|
+
# Request-specific options
|
2889
|
+
#
|
2890
|
+
# @yield [result, err] Result & error if block supplied
|
2891
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse] parsed result object
|
2892
|
+
# @yieldparam err [StandardError] error object if request failed
|
2893
|
+
#
|
2894
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse]
|
2895
|
+
#
|
2896
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2897
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2898
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2899
|
+
def complete_project_location_data_store_query(data_store, include_tail_suggestions: nil, query: nil, query_model: nil, user_pseudo_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2900
|
+
command = make_simple_command(:get, 'v1beta/{+dataStore}:completeQuery', options)
|
2901
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse::Representation
|
2902
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompleteQueryResponse
|
2903
|
+
command.params['dataStore'] = data_store unless data_store.nil?
|
2904
|
+
command.query['includeTailSuggestions'] = include_tail_suggestions unless include_tail_suggestions.nil?
|
2905
|
+
command.query['query'] = query unless query.nil?
|
2906
|
+
command.query['queryModel'] = query_model unless query_model.nil?
|
2907
|
+
command.query['userPseudoId'] = user_pseudo_id unless user_pseudo_id.nil?
|
2908
|
+
command.query['fields'] = fields unless fields.nil?
|
2909
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2910
|
+
execute_or_queue_command(command, &block)
|
2911
|
+
end
|
2912
|
+
|
2913
|
+
# Creates a DataStore. DataStore is for storing Documents. To serve these
|
2914
|
+
# documents for Search, or Recommendation use case, an Engine needs to be
|
2915
|
+
# created separately.
|
2916
|
+
# @param [String] parent
|
2917
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
2918
|
+
# location`/collections/`collection``.
|
2919
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore] google_cloud_discoveryengine_v1beta_data_store_object
|
2920
|
+
# @param [Boolean] create_advanced_site_search
|
2921
|
+
# A boolean flag indicating whether user want to directly create an advanced
|
2922
|
+
# data store for site search. If the data store is not configured as site search
|
2923
|
+
# (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be
|
2924
|
+
# ignored.
|
2925
|
+
# @param [String] data_store_id
|
2926
|
+
# Required. The ID to use for the DataStore, which will become the final
|
2927
|
+
# component of the DataStore's resource name. This field must conform to [RFC-
|
2928
|
+
# 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
|
2929
|
+
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
2930
|
+
# @param [String] fields
|
2931
|
+
# Selector specifying which fields to include in a partial response.
|
2932
|
+
# @param [String] quota_user
|
2933
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2934
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2935
|
+
# @param [Google::Apis::RequestOptions] options
|
2936
|
+
# Request-specific options
|
2937
|
+
#
|
2938
|
+
# @yield [result, err] Result & error if block supplied
|
2939
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2940
|
+
# @yieldparam err [StandardError] error object if request failed
|
2941
|
+
#
|
2942
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2943
|
+
#
|
2944
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2945
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2946
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2947
|
+
def create_project_location_data_store(parent, google_cloud_discoveryengine_v1beta_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2948
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/dataStores', options)
|
2949
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore::Representation
|
2950
|
+
command.request_object = google_cloud_discoveryengine_v1beta_data_store_object
|
2951
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2952
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2953
|
+
command.params['parent'] = parent unless parent.nil?
|
2954
|
+
command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
|
2955
|
+
command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
|
2956
|
+
command.query['fields'] = fields unless fields.nil?
|
2957
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2958
|
+
execute_or_queue_command(command, &block)
|
2959
|
+
end
|
2960
|
+
|
2961
|
+
# Deletes a DataStore.
|
2962
|
+
# @param [String] name
|
2963
|
+
# Required. Full resource name of DataStore, such as `projects/`project`/
|
2964
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
|
2965
|
+
# If the caller does not have permission to delete the DataStore, regardless of
|
2966
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned. If the
|
2967
|
+
# DataStore to delete does not exist, a NOT_FOUND error is returned.
|
2968
|
+
# @param [String] fields
|
2969
|
+
# Selector specifying which fields to include in a partial response.
|
2970
|
+
# @param [String] quota_user
|
2971
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2972
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2973
|
+
# @param [Google::Apis::RequestOptions] options
|
2974
|
+
# Request-specific options
|
2975
|
+
#
|
2976
|
+
# @yield [result, err] Result & error if block supplied
|
2977
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2978
|
+
# @yieldparam err [StandardError] error object if request failed
|
2979
|
+
#
|
2980
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2981
|
+
#
|
2982
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2983
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2984
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2985
|
+
def delete_project_location_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
2986
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
2987
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2988
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2989
|
+
command.params['name'] = name unless name.nil?
|
2990
|
+
command.query['fields'] = fields unless fields.nil?
|
2991
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2992
|
+
execute_or_queue_command(command, &block)
|
2993
|
+
end
|
2994
|
+
|
2995
|
+
# Gets a DataStore.
|
2996
|
+
# @param [String] name
|
2997
|
+
# Required. Full resource name of DataStore, such as `projects/`project`/
|
2998
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
|
2999
|
+
# If the caller does not have permission to access the DataStore, regardless of
|
3000
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned. If the
|
3001
|
+
# requested DataStore does not exist, a NOT_FOUND error is returned.
|
3002
|
+
# @param [String] fields
|
3003
|
+
# Selector specifying which fields to include in a partial response.
|
3004
|
+
# @param [String] quota_user
|
3005
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3006
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3007
|
+
# @param [Google::Apis::RequestOptions] options
|
3008
|
+
# Request-specific options
|
3009
|
+
#
|
3010
|
+
# @yield [result, err] Result & error if block supplied
|
3011
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore] parsed result object
|
3012
|
+
# @yieldparam err [StandardError] error object if request failed
|
3013
|
+
#
|
3014
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore]
|
3015
|
+
#
|
3016
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3017
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3018
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3019
|
+
def get_project_location_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
3020
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
3021
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore::Representation
|
3022
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore
|
3023
|
+
command.params['name'] = name unless name.nil?
|
3024
|
+
command.query['fields'] = fields unless fields.nil?
|
3025
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3026
|
+
execute_or_queue_command(command, &block)
|
3027
|
+
end
|
3028
|
+
|
3029
|
+
# Gets the SiteSearchEngine.
|
3030
|
+
# @param [String] name
|
3031
|
+
# Required. Resource name of SiteSearchEngine, such as `projects/`project`/
|
3032
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/
|
3033
|
+
# siteSearchEngine`. If the caller does not have permission to access the [
|
3034
|
+
# SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED
|
3035
|
+
# error is returned.
|
3036
|
+
# @param [String] fields
|
3037
|
+
# Selector specifying which fields to include in a partial response.
|
3038
|
+
# @param [String] quota_user
|
3039
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3040
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3041
|
+
# @param [Google::Apis::RequestOptions] options
|
3042
|
+
# Request-specific options
|
3043
|
+
#
|
3044
|
+
# @yield [result, err] Result & error if block supplied
|
3045
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteSearchEngine] parsed result object
|
3046
|
+
# @yieldparam err [StandardError] error object if request failed
|
3047
|
+
#
|
3048
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteSearchEngine]
|
3049
|
+
#
|
3050
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3051
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3052
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3053
|
+
def get_project_location_data_store_site_search_engine(name, fields: nil, quota_user: nil, options: nil, &block)
|
3054
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
3055
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteSearchEngine::Representation
|
3056
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteSearchEngine
|
3057
|
+
command.params['name'] = name unless name.nil?
|
3058
|
+
command.query['fields'] = fields unless fields.nil?
|
3059
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3060
|
+
execute_or_queue_command(command, &block)
|
3061
|
+
end
|
3062
|
+
|
3063
|
+
# Lists all the DataStores associated with the project.
|
3064
|
+
# @param [String] parent
|
3065
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
3066
|
+
# locations/`location`/collections/`collection_id``. If the caller does not have
|
3067
|
+
# permission to list DataStores under this location, regardless of whether or
|
3068
|
+
# not this data store exists, a PERMISSION_DENIED error is returned.
|
3069
|
+
# @param [String] filter
|
3070
|
+
# Filter by solution type. For example: filter = 'solution_type:
|
3071
|
+
# SOLUTION_TYPE_SEARCH'
|
3072
|
+
# @param [Fixnum] page_size
|
3073
|
+
# Maximum number of DataStores to return. If unspecified, defaults to 10. The
|
3074
|
+
# maximum allowed value is 50. Values above 50 will be coerced to 50. If this
|
3075
|
+
# field is negative, an INVALID_ARGUMENT is returned.
|
3076
|
+
# @param [String] page_token
|
3077
|
+
# A page token ListDataStoresResponse.next_page_token, received from a previous
|
3078
|
+
# DataStoreService.ListDataStores call. Provide this to retrieve the subsequent
|
3079
|
+
# page. When paginating, all other parameters provided to DataStoreService.
|
3080
|
+
# ListDataStores must match the call that provided the page token. Otherwise, an
|
3081
|
+
# INVALID_ARGUMENT error is returned.
|
3082
|
+
# @param [String] fields
|
3083
|
+
# Selector specifying which fields to include in a partial response.
|
3084
|
+
# @param [String] quota_user
|
3085
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3086
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3087
|
+
# @param [Google::Apis::RequestOptions] options
|
3088
|
+
# Request-specific options
|
3089
|
+
#
|
3090
|
+
# @yield [result, err] Result & error if block supplied
|
3091
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDataStoresResponse] parsed result object
|
3092
|
+
# @yieldparam err [StandardError] error object if request failed
|
3093
|
+
#
|
3094
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDataStoresResponse]
|
3095
|
+
#
|
3096
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3097
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3098
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3099
|
+
def list_project_location_data_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3100
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/dataStores', options)
|
3101
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDataStoresResponse::Representation
|
3102
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDataStoresResponse
|
3103
|
+
command.params['parent'] = parent unless parent.nil?
|
3104
|
+
command.query['filter'] = filter unless filter.nil?
|
3105
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3106
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3107
|
+
command.query['fields'] = fields unless fields.nil?
|
3108
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3109
|
+
execute_or_queue_command(command, &block)
|
3110
|
+
end
|
3111
|
+
|
3112
|
+
# Updates a DataStore
|
3113
|
+
# @param [String] name
|
3114
|
+
# Immutable. The full resource name of the data store. Format: `projects/`
|
3115
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
3116
|
+
# data_store_id``. This field must be a UTF-8 encoded string with a length limit
|
3117
|
+
# of 1024 characters.
|
3118
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore] google_cloud_discoveryengine_v1beta_data_store_object
|
3119
|
+
# @param [String] update_mask
|
3120
|
+
# Indicates which fields in the provided DataStore to update. If an unsupported
|
3121
|
+
# or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
3122
|
+
# @param [String] fields
|
3123
|
+
# Selector specifying which fields to include in a partial response.
|
3124
|
+
# @param [String] quota_user
|
3125
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3126
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3127
|
+
# @param [Google::Apis::RequestOptions] options
|
3128
|
+
# Request-specific options
|
3129
|
+
#
|
3130
|
+
# @yield [result, err] Result & error if block supplied
|
3131
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore] parsed result object
|
3132
|
+
# @yieldparam err [StandardError] error object if request failed
|
3133
|
+
#
|
3134
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore]
|
3135
|
+
#
|
3136
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3137
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3138
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3139
|
+
def patch_project_location_data_store(name, google_cloud_discoveryengine_v1beta_data_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3140
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
3141
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore::Representation
|
3142
|
+
command.request_object = google_cloud_discoveryengine_v1beta_data_store_object
|
3143
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore::Representation
|
3144
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore
|
3145
|
+
command.params['name'] = name unless name.nil?
|
3146
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
3147
|
+
command.query['fields'] = fields unless fields.nil?
|
3148
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3149
|
+
execute_or_queue_command(command, &block)
|
3150
|
+
end
|
3151
|
+
|
3152
|
+
# Creates a Document.
|
3153
|
+
# @param [String] parent
|
3154
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
3155
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
3156
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
3157
|
+
# @param [String] document_id
|
3158
|
+
# Required. The ID to use for the Document, which will become the final
|
3159
|
+
# component of the Document.name. If the caller does not have permission to
|
3160
|
+
# create the Document, regardless of whether or not it exists, a `
|
3161
|
+
# PERMISSION_DENIED` error is returned. This field must be unique among all
|
3162
|
+
# Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
3163
|
+
# returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
3164
|
+
# rfc1034) standard with a length limit of 63 characters. Otherwise, an `
|
3165
|
+
# INVALID_ARGUMENT` error is returned.
|
3166
|
+
# @param [String] fields
|
3167
|
+
# Selector specifying which fields to include in a partial response.
|
3168
|
+
# @param [String] quota_user
|
3169
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3170
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3171
|
+
# @param [Google::Apis::RequestOptions] options
|
3172
|
+
# Request-specific options
|
3173
|
+
#
|
3174
|
+
# @yield [result, err] Result & error if block supplied
|
3175
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
|
3176
|
+
# @yieldparam err [StandardError] error object if request failed
|
3177
|
+
#
|
3178
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
|
3179
|
+
#
|
3180
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3181
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3182
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3183
|
+
def create_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_document_object = nil, document_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3184
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/documents', options)
|
3185
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
3186
|
+
command.request_object = google_cloud_discoveryengine_v1beta_document_object
|
3187
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
3188
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
|
3189
|
+
command.params['parent'] = parent unless parent.nil?
|
3190
|
+
command.query['documentId'] = document_id unless document_id.nil?
|
3191
|
+
command.query['fields'] = fields unless fields.nil?
|
3192
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3193
|
+
execute_or_queue_command(command, &block)
|
3194
|
+
end
|
3195
|
+
|
3196
|
+
# Deletes a Document.
|
3197
|
+
# @param [String] name
|
3198
|
+
# Required. Full resource name of Document, such as `projects/`project`/
|
3199
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
3200
|
+
# `branch`/documents/`document``. If the caller does not have permission to
|
3201
|
+
# delete the Document, regardless of whether or not it exists, a `
|
3202
|
+
# PERMISSION_DENIED` error is returned. If the Document to delete does not exist,
|
3203
|
+
# a `NOT_FOUND` error is returned.
|
3204
|
+
# @param [String] fields
|
3205
|
+
# Selector specifying which fields to include in a partial response.
|
3206
|
+
# @param [String] quota_user
|
3207
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3208
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3209
|
+
# @param [Google::Apis::RequestOptions] options
|
3210
|
+
# Request-specific options
|
3211
|
+
#
|
3212
|
+
# @yield [result, err] Result & error if block supplied
|
3213
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
3214
|
+
# @yieldparam err [StandardError] error object if request failed
|
3215
|
+
#
|
3216
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
3217
|
+
#
|
3218
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3219
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3220
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3221
|
+
def delete_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
|
3222
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
3223
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
3224
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
3225
|
+
command.params['name'] = name unless name.nil?
|
3226
|
+
command.query['fields'] = fields unless fields.nil?
|
3227
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3228
|
+
execute_or_queue_command(command, &block)
|
3229
|
+
end
|
3230
|
+
|
3231
|
+
# Gets a Document.
|
3232
|
+
# @param [String] name
|
3233
|
+
# Required. Full resource name of Document, such as `projects/`project`/
|
3234
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
3235
|
+
# `branch`/documents/`document``. If the caller does not have permission to
|
3236
|
+
# access the Document, regardless of whether or not it exists, a `
|
3237
|
+
# PERMISSION_DENIED` error is returned. If the requested Document does not exist,
|
3238
|
+
# a `NOT_FOUND` error is returned.
|
3239
|
+
# @param [String] fields
|
3240
|
+
# Selector specifying which fields to include in a partial response.
|
3241
|
+
# @param [String] quota_user
|
3242
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3243
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3244
|
+
# @param [Google::Apis::RequestOptions] options
|
3245
|
+
# Request-specific options
|
3246
|
+
#
|
3247
|
+
# @yield [result, err] Result & error if block supplied
|
3248
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
|
3249
|
+
# @yieldparam err [StandardError] error object if request failed
|
3250
|
+
#
|
3251
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
|
3252
|
+
#
|
3253
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3254
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3255
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3256
|
+
def get_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
|
3257
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
3258
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
3259
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
|
3260
|
+
command.params['name'] = name unless name.nil?
|
3261
|
+
command.query['fields'] = fields unless fields.nil?
|
3262
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3263
|
+
execute_or_queue_command(command, &block)
|
3264
|
+
end
|
3265
|
+
|
3266
|
+
# Bulk import of multiple Documents. Request processing may be synchronous. Non-
|
3267
|
+
# existing items will be created. Note: It is possible for a subset of the
|
3268
|
+
# Documents to be successfully updated.
|
3269
|
+
# @param [String] parent
|
3270
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
3271
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
3272
|
+
# `branch``. Requires create/update permission.
|
3273
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequest] google_cloud_discoveryengine_v1beta_import_documents_request_object
|
3274
|
+
# @param [String] fields
|
3275
|
+
# Selector specifying which fields to include in a partial response.
|
3276
|
+
# @param [String] quota_user
|
3277
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3278
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3279
|
+
# @param [Google::Apis::RequestOptions] options
|
3280
|
+
# Request-specific options
|
3281
|
+
#
|
3282
|
+
# @yield [result, err] Result & error if block supplied
|
3283
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
3284
|
+
# @yieldparam err [StandardError] error object if request failed
|
3285
|
+
#
|
3286
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
3287
|
+
#
|
3288
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3289
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3290
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3291
|
+
def import_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3292
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/documents:import', options)
|
3293
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequest::Representation
|
3294
|
+
command.request_object = google_cloud_discoveryengine_v1beta_import_documents_request_object
|
3295
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
3296
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
3297
|
+
command.params['parent'] = parent unless parent.nil?
|
3298
|
+
command.query['fields'] = fields unless fields.nil?
|
3299
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3300
|
+
execute_or_queue_command(command, &block)
|
3301
|
+
end
|
3302
|
+
|
3303
|
+
# Gets a list of Documents.
|
3304
|
+
# @param [String] parent
|
3305
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
3306
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
3307
|
+
# `branch``. Use `default_branch` as the branch ID, to list documents under the
|
3308
|
+
# default branch. If the caller does not have permission to list Documents under
|
3309
|
+
# this branch, regardless of whether or not this branch exists, a `
|
3310
|
+
# PERMISSION_DENIED` error is returned.
|
3311
|
+
# @param [Fixnum] page_size
|
3312
|
+
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
3313
|
+
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
3314
|
+
# this field is negative, an `INVALID_ARGUMENT` error is returned.
|
3315
|
+
# @param [String] page_token
|
3316
|
+
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
3317
|
+
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
3318
|
+
# page. When paginating, all other parameters provided to DocumentService.
|
3319
|
+
# ListDocuments must match the call that provided the page token. Otherwise, an `
|
3320
|
+
# INVALID_ARGUMENT` error is returned.
|
3321
|
+
# @param [String] fields
|
3322
|
+
# Selector specifying which fields to include in a partial response.
|
3323
|
+
# @param [String] quota_user
|
3324
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3325
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3326
|
+
# @param [Google::Apis::RequestOptions] options
|
3327
|
+
# Request-specific options
|
3328
|
+
#
|
3329
|
+
# @yield [result, err] Result & error if block supplied
|
3330
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse] parsed result object
|
3331
|
+
# @yieldparam err [StandardError] error object if request failed
|
3332
|
+
#
|
3333
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse]
|
3334
|
+
#
|
3335
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3336
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3337
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3338
|
+
def list_project_location_data_store_branch_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3339
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/documents', options)
|
3340
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse::Representation
|
3341
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse
|
3342
|
+
command.params['parent'] = parent unless parent.nil?
|
3343
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3344
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3345
|
+
command.query['fields'] = fields unless fields.nil?
|
3346
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3347
|
+
execute_or_queue_command(command, &block)
|
3348
|
+
end
|
3349
|
+
|
3350
|
+
# Updates a Document.
|
3351
|
+
# @param [String] name
|
3352
|
+
# Immutable. The full resource name of the document. Format: `projects/`project`/
|
3353
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
3354
|
+
# `branch`/documents/`document_id``. This field must be a UTF-8 encoded string
|
3355
|
+
# with a length limit of 1024 characters.
|
3356
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
3357
|
+
# @param [Boolean] allow_missing
|
3358
|
+
# If set to true, and the Document is not found, a new Document will be created.
|
3359
|
+
# @param [String] fields
|
3360
|
+
# Selector specifying which fields to include in a partial response.
|
3361
|
+
# @param [String] quota_user
|
3362
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3363
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3364
|
+
# @param [Google::Apis::RequestOptions] options
|
3365
|
+
# Request-specific options
|
3366
|
+
#
|
3367
|
+
# @yield [result, err] Result & error if block supplied
|
3368
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
|
3369
|
+
# @yieldparam err [StandardError] error object if request failed
|
3370
|
+
#
|
3371
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
|
3372
|
+
#
|
3373
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3374
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3375
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3376
|
+
def patch_project_location_data_store_branch_document(name, google_cloud_discoveryengine_v1beta_document_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3377
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
3378
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
3379
|
+
command.request_object = google_cloud_discoveryengine_v1beta_document_object
|
3380
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
3381
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
|
3382
|
+
command.params['name'] = name unless name.nil?
|
3383
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
3384
|
+
command.query['fields'] = fields unless fields.nil?
|
3385
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3386
|
+
execute_or_queue_command(command, &block)
|
3387
|
+
end
|
3388
|
+
|
3389
|
+
# Permanently deletes all selected Documents in a branch. This process is
|
3390
|
+
# asynchronous. Depending on the number of Documents to be deleted, this
|
3391
|
+
# operation can take hours to complete. Before the delete operation completes,
|
3392
|
+
# some Documents might still be returned by DocumentService.GetDocument or
|
3393
|
+
# DocumentService.ListDocuments. To get a list of the Documents to be deleted,
|
3394
|
+
# set PurgeDocumentsRequest.force to false.
|
3395
|
+
# @param [String] parent
|
3396
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
3397
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
3398
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest] google_cloud_discoveryengine_v1beta_purge_documents_request_object
|
3399
|
+
# @param [String] fields
|
3400
|
+
# Selector specifying which fields to include in a partial response.
|
3401
|
+
# @param [String] quota_user
|
3402
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3403
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3404
|
+
# @param [Google::Apis::RequestOptions] options
|
3405
|
+
# Request-specific options
|
3406
|
+
#
|
3407
|
+
# @yield [result, err] Result & error if block supplied
|
3408
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
3409
|
+
# @yieldparam err [StandardError] error object if request failed
|
3410
|
+
#
|
3411
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
3412
|
+
#
|
3413
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3414
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3415
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3416
|
+
def purge_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3417
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/documents:purge', options)
|
3418
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest::Representation
|
3419
|
+
command.request_object = google_cloud_discoveryengine_v1beta_purge_documents_request_object
|
3420
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
3421
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
3422
|
+
command.params['parent'] = parent unless parent.nil?
|
3423
|
+
command.query['fields'] = fields unless fields.nil?
|
3424
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3425
|
+
execute_or_queue_command(command, &block)
|
3426
|
+
end
|
3427
|
+
|
3428
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
3429
|
+
# to poll the operation result at intervals as recommended by the API service.
|
3430
|
+
# @param [String] name
|
3431
|
+
# The name of the operation resource.
|
3432
|
+
# @param [String] fields
|
3433
|
+
# Selector specifying which fields to include in a partial response.
|
3434
|
+
# @param [String] quota_user
|
3435
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3436
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3437
|
+
# @param [Google::Apis::RequestOptions] options
|
3438
|
+
# Request-specific options
|
3439
|
+
#
|
3440
|
+
# @yield [result, err] Result & error if block supplied
|
3441
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
3442
|
+
# @yieldparam err [StandardError] error object if request failed
|
3443
|
+
#
|
3444
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
3445
|
+
#
|
3446
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3447
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3448
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3449
|
+
def get_project_location_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
3450
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
3451
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
3452
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
3453
|
+
command.params['name'] = name unless name.nil?
|
3454
|
+
command.query['fields'] = fields unless fields.nil?
|
3455
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3456
|
+
execute_or_queue_command(command, &block)
|
3457
|
+
end
|
3458
|
+
|
3459
|
+
# Lists operations that match the specified filter in the request. If the server
|
3460
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
3461
|
+
# @param [String] name
|
3462
|
+
# The name of the operation's parent resource.
|
3463
|
+
# @param [String] filter
|
3464
|
+
# The standard list filter.
|
3465
|
+
# @param [Fixnum] page_size
|
3466
|
+
# The standard list page size.
|
3467
|
+
# @param [String] page_token
|
3468
|
+
# The standard list page token.
|
3469
|
+
# @param [String] fields
|
3470
|
+
# Selector specifying which fields to include in a partial response.
|
1920
3471
|
# @param [String] quota_user
|
1921
3472
|
# Available to use for quota purposes for server-side applications. Can be any
|
1922
3473
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
@@ -1932,7 +3483,7 @@ module Google
|
|
1932
3483
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1933
3484
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1934
3485
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1935
|
-
def
|
3486
|
+
def list_project_location_data_store_branch_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1936
3487
|
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
1937
3488
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
1938
3489
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
@@ -1945,37 +3496,15 @@ module Google
|
|
1945
3496
|
execute_or_queue_command(command, &block)
|
1946
3497
|
end
|
1947
3498
|
|
1948
|
-
#
|
1949
|
-
# @param [String]
|
1950
|
-
# Required. The
|
1951
|
-
#
|
1952
|
-
#
|
1953
|
-
#
|
1954
|
-
#
|
1955
|
-
#
|
1956
|
-
#
|
1957
|
-
# @param [String] query
|
1958
|
-
# Required. The typeahead input used to fetch suggestions. Maximum length is 128
|
1959
|
-
# characters.
|
1960
|
-
# @param [String] query_model
|
1961
|
-
# Selects data model of query suggestions for serving. Currently supported
|
1962
|
-
# values: * `document` - Using suggestions generated from user-imported
|
1963
|
-
# documents. * `search-history` - Using suggestions generated from the past
|
1964
|
-
# history of SearchService.Search API calls. Do not use it when there is no
|
1965
|
-
# traffic for Search API. * `user-event` - Using suggestions generated from user-
|
1966
|
-
# imported search events. * `document-completable` - Using suggestions taken
|
1967
|
-
# directly from user-imported document fields marked as completable. Default
|
1968
|
-
# values: * `document` is the default model for regular dataStores. * `search-
|
1969
|
-
# history` is the default model for site search dataStores.
|
1970
|
-
# @param [String] user_pseudo_id
|
1971
|
-
# A unique identifier for tracking visitors. For example, this could be
|
1972
|
-
# implemented with an HTTP cookie, which should be able to uniquely identify a
|
1973
|
-
# visitor on a single device. This unique identifier should not change if the
|
1974
|
-
# visitor logs in or out of the website. This field should NOT have a fixed
|
1975
|
-
# value such as `unknown_visitor`. This should be the same identifier as
|
1976
|
-
# UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
|
1977
|
-
# UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `
|
1978
|
-
# INVALID_ARGUMENT` error is returned.
|
3499
|
+
# Converses a conversation.
|
3500
|
+
# @param [String] name
|
3501
|
+
# Required. The resource name of the Conversation to get. Format: `projects/`
|
3502
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
3503
|
+
# data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
|
3504
|
+
# /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
|
3505
|
+
# conversations/-` to activate auto session mode, which automatically creates a
|
3506
|
+
# new conversation inside a ConverseConversation session.
|
3507
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest] google_cloud_discoveryengine_v1beta_converse_conversation_request_object
|
1979
3508
|
# @param [String] fields
|
1980
3509
|
# Selector specifying which fields to include in a partial response.
|
1981
3510
|
# @param [String] quota_user
|
@@ -1985,42 +3514,33 @@ module Google
|
|
1985
3514
|
# Request-specific options
|
1986
3515
|
#
|
1987
3516
|
# @yield [result, err] Result & error if block supplied
|
1988
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3517
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse] parsed result object
|
1989
3518
|
# @yieldparam err [StandardError] error object if request failed
|
1990
3519
|
#
|
1991
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3520
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse]
|
1992
3521
|
#
|
1993
3522
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1994
3523
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1995
3524
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1996
|
-
def
|
1997
|
-
command = make_simple_command(:
|
1998
|
-
command.
|
1999
|
-
command.
|
2000
|
-
command.
|
2001
|
-
command.
|
2002
|
-
command.
|
2003
|
-
command.query['queryModel'] = query_model unless query_model.nil?
|
2004
|
-
command.query['userPseudoId'] = user_pseudo_id unless user_pseudo_id.nil?
|
3525
|
+
def converse_project_location_data_store_conversation(name, google_cloud_discoveryengine_v1beta_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3526
|
+
command = make_simple_command(:post, 'v1beta/{+name}:converse', options)
|
3527
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest::Representation
|
3528
|
+
command.request_object = google_cloud_discoveryengine_v1beta_converse_conversation_request_object
|
3529
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse::Representation
|
3530
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse
|
3531
|
+
command.params['name'] = name unless name.nil?
|
2005
3532
|
command.query['fields'] = fields unless fields.nil?
|
2006
3533
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2007
3534
|
execute_or_queue_command(command, &block)
|
2008
3535
|
end
|
2009
3536
|
|
2010
|
-
# Creates a
|
3537
|
+
# Creates a Conversation. If the Conversation to create already exists, an
|
3538
|
+
# ALREADY_EXISTS error is returned.
|
2011
3539
|
# @param [String] parent
|
2012
|
-
# Required.
|
2013
|
-
#
|
2014
|
-
#
|
2015
|
-
# @param [
|
2016
|
-
# Required. The ID to use for the Document, which will become the final
|
2017
|
-
# component of the Document.name. If the caller does not have permission to
|
2018
|
-
# create the Document, regardless of whether or not it exists, a `
|
2019
|
-
# PERMISSION_DENIED` error is returned. This field must be unique among all
|
2020
|
-
# Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
2021
|
-
# returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
2022
|
-
# rfc1034) standard with a length limit of 63 characters. Otherwise, an `
|
2023
|
-
# INVALID_ARGUMENT` error is returned.
|
3540
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
3541
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
3542
|
+
# data_store_id``
|
3543
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
|
2024
3544
|
# @param [String] fields
|
2025
3545
|
# Selector specifying which fields to include in a partial response.
|
2026
3546
|
# @param [String] quota_user
|
@@ -2030,35 +3550,32 @@ module Google
|
|
2030
3550
|
# Request-specific options
|
2031
3551
|
#
|
2032
3552
|
# @yield [result, err] Result & error if block supplied
|
2033
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3553
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
|
2034
3554
|
# @yieldparam err [StandardError] error object if request failed
|
2035
3555
|
#
|
2036
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3556
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
|
2037
3557
|
#
|
2038
3558
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2039
3559
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2040
3560
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2041
|
-
def
|
2042
|
-
command = make_simple_command(:post, 'v1beta/{+parent}/
|
2043
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
2044
|
-
command.request_object =
|
2045
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
2046
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
3561
|
+
def create_project_location_data_store_conversation(parent, google_cloud_discoveryengine_v1beta_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3562
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/conversations', options)
|
3563
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
3564
|
+
command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
|
3565
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
3566
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
|
2047
3567
|
command.params['parent'] = parent unless parent.nil?
|
2048
|
-
command.query['documentId'] = document_id unless document_id.nil?
|
2049
3568
|
command.query['fields'] = fields unless fields.nil?
|
2050
3569
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2051
3570
|
execute_or_queue_command(command, &block)
|
2052
3571
|
end
|
2053
3572
|
|
2054
|
-
# Deletes a
|
3573
|
+
# Deletes a Conversation. If the Conversation to delete does not exist, a
|
3574
|
+
# NOT_FOUND error is returned.
|
2055
3575
|
# @param [String] name
|
2056
|
-
# Required.
|
2057
|
-
# locations/`
|
2058
|
-
#
|
2059
|
-
# delete the Document, regardless of whether or not it exists, a `
|
2060
|
-
# PERMISSION_DENIED` error is returned. If the Document to delete does not exist,
|
2061
|
-
# a `NOT_FOUND` error is returned.
|
3576
|
+
# Required. The resource name of the Conversation to delete. Format: `projects/`
|
3577
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
3578
|
+
# data_store_id`/conversations/`conversation_id``
|
2062
3579
|
# @param [String] fields
|
2063
3580
|
# Selector specifying which fields to include in a partial response.
|
2064
3581
|
# @param [String] quota_user
|
@@ -2076,7 +3593,7 @@ module Google
|
|
2076
3593
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2077
3594
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2078
3595
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2079
|
-
def
|
3596
|
+
def delete_project_location_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2080
3597
|
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
2081
3598
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
2082
3599
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
@@ -2086,14 +3603,11 @@ module Google
|
|
2086
3603
|
execute_or_queue_command(command, &block)
|
2087
3604
|
end
|
2088
3605
|
|
2089
|
-
# Gets a
|
3606
|
+
# Gets a Conversation.
|
2090
3607
|
# @param [String] name
|
2091
|
-
# Required.
|
2092
|
-
# locations/`
|
2093
|
-
#
|
2094
|
-
# access the Document, regardless of whether or not it exists, a `
|
2095
|
-
# PERMISSION_DENIED` error is returned. If the requested Document does not exist,
|
2096
|
-
# a `NOT_FOUND` error is returned.
|
3608
|
+
# Required. The resource name of the Conversation to get. Format: `projects/`
|
3609
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
3610
|
+
# data_store_id`/conversations/`conversation_id``
|
2097
3611
|
# @param [String] fields
|
2098
3612
|
# Selector specifying which fields to include in a partial response.
|
2099
3613
|
# @param [String] quota_user
|
@@ -2103,32 +3617,41 @@ module Google
|
|
2103
3617
|
# Request-specific options
|
2104
3618
|
#
|
2105
3619
|
# @yield [result, err] Result & error if block supplied
|
2106
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3620
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
|
2107
3621
|
# @yieldparam err [StandardError] error object if request failed
|
2108
3622
|
#
|
2109
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3623
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
|
2110
3624
|
#
|
2111
3625
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2112
3626
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2113
3627
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2114
|
-
def
|
3628
|
+
def get_project_location_data_store_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2115
3629
|
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
2116
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
2117
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
3630
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
3631
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
|
2118
3632
|
command.params['name'] = name unless name.nil?
|
2119
3633
|
command.query['fields'] = fields unless fields.nil?
|
2120
3634
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2121
3635
|
execute_or_queue_command(command, &block)
|
2122
3636
|
end
|
2123
3637
|
|
2124
|
-
#
|
2125
|
-
# existing items will be created. Note: It is possible for a subset of the
|
2126
|
-
# Documents to be successfully updated.
|
3638
|
+
# Lists all Conversations by their parent DataStore.
|
2127
3639
|
# @param [String] parent
|
2128
|
-
# Required. The
|
2129
|
-
# locations/`
|
2130
|
-
#
|
2131
|
-
#
|
3640
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
3641
|
+
# locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
|
3642
|
+
# @param [String] filter
|
3643
|
+
# A filter to apply on the list results. The supported features are:
|
3644
|
+
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
3645
|
+
# @param [String] order_by
|
3646
|
+
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
3647
|
+
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
3648
|
+
# create_time` * `conversation_name` Example: "update_time desc" "create_time"
|
3649
|
+
# @param [Fixnum] page_size
|
3650
|
+
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
3651
|
+
# allowed value is 1000.
|
3652
|
+
# @param [String] page_token
|
3653
|
+
# A page token, received from a previous `ListConversations` call. Provide this
|
3654
|
+
# to retrieve the subsequent page.
|
2132
3655
|
# @param [String] fields
|
2133
3656
|
# Selector specifying which fields to include in a partial response.
|
2134
3657
|
# @param [String] quota_user
|
@@ -2138,44 +3661,39 @@ module Google
|
|
2138
3661
|
# Request-specific options
|
2139
3662
|
#
|
2140
3663
|
# @yield [result, err] Result & error if block supplied
|
2141
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3664
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse] parsed result object
|
2142
3665
|
# @yieldparam err [StandardError] error object if request failed
|
2143
3666
|
#
|
2144
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3667
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse]
|
2145
3668
|
#
|
2146
3669
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2147
3670
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2148
3671
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2149
|
-
def
|
2150
|
-
command = make_simple_command(:
|
2151
|
-
command.
|
2152
|
-
command.
|
2153
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2154
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
3672
|
+
def list_project_location_data_store_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3673
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/conversations', options)
|
3674
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse::Representation
|
3675
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse
|
2155
3676
|
command.params['parent'] = parent unless parent.nil?
|
3677
|
+
command.query['filter'] = filter unless filter.nil?
|
3678
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
3679
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3680
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2156
3681
|
command.query['fields'] = fields unless fields.nil?
|
2157
3682
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2158
3683
|
execute_or_queue_command(command, &block)
|
2159
3684
|
end
|
2160
3685
|
|
2161
|
-
#
|
2162
|
-
#
|
2163
|
-
#
|
2164
|
-
# locations
|
2165
|
-
#
|
2166
|
-
#
|
2167
|
-
#
|
2168
|
-
#
|
2169
|
-
#
|
2170
|
-
#
|
2171
|
-
#
|
2172
|
-
# this field is negative, an `INVALID_ARGUMENT` error is returned.
|
2173
|
-
# @param [String] page_token
|
2174
|
-
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
2175
|
-
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
2176
|
-
# page. When paginating, all other parameters provided to DocumentService.
|
2177
|
-
# ListDocuments must match the call that provided the page token. Otherwise, an `
|
2178
|
-
# INVALID_ARGUMENT` error is returned.
|
3686
|
+
# Updates a Conversation. Conversation action type cannot be changed. If the
|
3687
|
+
# Conversation to update does not exist, a NOT_FOUND error is returned.
|
3688
|
+
# @param [String] name
|
3689
|
+
# Immutable. Fully qualified name `project/*/locations/global/collections/`
|
3690
|
+
# collection`/dataStore/*/conversations/*` or `project/*/locations/global/
|
3691
|
+
# collections/`collection`/engines/*/conversations/*`.
|
3692
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
|
3693
|
+
# @param [String] update_mask
|
3694
|
+
# Indicates which fields in the provided Conversation to update. The following
|
3695
|
+
# are NOT supported: * Conversation.name If not set or empty, all supported
|
3696
|
+
# fields are updated.
|
2179
3697
|
# @param [String] fields
|
2180
3698
|
# Selector specifying which fields to include in a partial response.
|
2181
3699
|
# @param [String] quota_user
|
@@ -2185,35 +3703,31 @@ module Google
|
|
2185
3703
|
# Request-specific options
|
2186
3704
|
#
|
2187
3705
|
# @yield [result, err] Result & error if block supplied
|
2188
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3706
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
|
2189
3707
|
# @yieldparam err [StandardError] error object if request failed
|
2190
3708
|
#
|
2191
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3709
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
|
2192
3710
|
#
|
2193
3711
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2194
3712
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2195
3713
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2196
|
-
def
|
2197
|
-
command = make_simple_command(:
|
2198
|
-
command.
|
2199
|
-
command.
|
2200
|
-
command.
|
2201
|
-
command.
|
2202
|
-
command.
|
3714
|
+
def patch_project_location_data_store_conversation(name, google_cloud_discoveryengine_v1beta_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3715
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
3716
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
3717
|
+
command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
|
3718
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
|
3719
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
|
3720
|
+
command.params['name'] = name unless name.nil?
|
3721
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2203
3722
|
command.query['fields'] = fields unless fields.nil?
|
2204
3723
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2205
3724
|
execute_or_queue_command(command, &block)
|
2206
3725
|
end
|
2207
3726
|
|
2208
|
-
#
|
3727
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
3728
|
+
# to poll the operation result at intervals as recommended by the API service.
|
2209
3729
|
# @param [String] name
|
2210
|
-
#
|
2211
|
-
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
2212
|
-
# `branch`/documents/`document_id``. This field must be a UTF-8 encoded string
|
2213
|
-
# with a length limit of 1024 characters.
|
2214
|
-
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
2215
|
-
# @param [Boolean] allow_missing
|
2216
|
-
# If set to true, and the Document is not found, a new Document will be created.
|
3730
|
+
# The name of the operation resource.
|
2217
3731
|
# @param [String] fields
|
2218
3732
|
# Selector specifying which fields to include in a partial response.
|
2219
3733
|
# @param [String] quota_user
|
@@ -2223,37 +3737,34 @@ module Google
|
|
2223
3737
|
# Request-specific options
|
2224
3738
|
#
|
2225
3739
|
# @yield [result, err] Result & error if block supplied
|
2226
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3740
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2227
3741
|
# @yieldparam err [StandardError] error object if request failed
|
2228
3742
|
#
|
2229
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3743
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2230
3744
|
#
|
2231
3745
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2232
3746
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2233
3747
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2234
|
-
def
|
2235
|
-
command = make_simple_command(:
|
2236
|
-
command.
|
2237
|
-
command.
|
2238
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
2239
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
|
3748
|
+
def get_project_location_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
3749
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
3750
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
3751
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2240
3752
|
command.params['name'] = name unless name.nil?
|
2241
|
-
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
2242
3753
|
command.query['fields'] = fields unless fields.nil?
|
2243
3754
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2244
3755
|
execute_or_queue_command(command, &block)
|
2245
3756
|
end
|
2246
3757
|
|
2247
|
-
#
|
2248
|
-
#
|
2249
|
-
#
|
2250
|
-
#
|
2251
|
-
#
|
2252
|
-
#
|
2253
|
-
# @param [
|
2254
|
-
#
|
2255
|
-
#
|
2256
|
-
#
|
3758
|
+
# Lists operations that match the specified filter in the request. If the server
|
3759
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
3760
|
+
# @param [String] name
|
3761
|
+
# The name of the operation's parent resource.
|
3762
|
+
# @param [String] filter
|
3763
|
+
# The standard list filter.
|
3764
|
+
# @param [Fixnum] page_size
|
3765
|
+
# The standard list page size.
|
3766
|
+
# @param [String] page_token
|
3767
|
+
# The standard list page token.
|
2257
3768
|
# @param [String] fields
|
2258
3769
|
# Selector specifying which fields to include in a partial response.
|
2259
3770
|
# @param [String] quota_user
|
@@ -2263,21 +3774,22 @@ module Google
|
|
2263
3774
|
# Request-specific options
|
2264
3775
|
#
|
2265
3776
|
# @yield [result, err] Result & error if block supplied
|
2266
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3777
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
2267
3778
|
# @yieldparam err [StandardError] error object if request failed
|
2268
3779
|
#
|
2269
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3780
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
2270
3781
|
#
|
2271
3782
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2272
3783
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2273
3784
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2274
|
-
def
|
2275
|
-
command = make_simple_command(:
|
2276
|
-
command.
|
2277
|
-
command.
|
2278
|
-
command.
|
2279
|
-
command.
|
2280
|
-
command.
|
3785
|
+
def list_project_location_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3786
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
3787
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
3788
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
3789
|
+
command.params['name'] = name unless name.nil?
|
3790
|
+
command.query['filter'] = filter unless filter.nil?
|
3791
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3792
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2281
3793
|
command.query['fields'] = fields unless fields.nil?
|
2282
3794
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2283
3795
|
execute_or_queue_command(command, &block)
|
@@ -2304,7 +3816,7 @@ module Google
|
|
2304
3816
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2305
3817
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2306
3818
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2307
|
-
def
|
3819
|
+
def get_project_location_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
2308
3820
|
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
2309
3821
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2310
3822
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
@@ -2341,7 +3853,7 @@ module Google
|
|
2341
3853
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2342
3854
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2343
3855
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2344
|
-
def
|
3856
|
+
def list_project_location_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2345
3857
|
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
2346
3858
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
2347
3859
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
@@ -2354,15 +3866,16 @@ module Google
|
|
2354
3866
|
execute_or_queue_command(command, &block)
|
2355
3867
|
end
|
2356
3868
|
|
2357
|
-
#
|
2358
|
-
# @param [String]
|
2359
|
-
# Required. The resource name
|
2360
|
-
#
|
2361
|
-
#
|
2362
|
-
#
|
2363
|
-
#
|
2364
|
-
#
|
2365
|
-
#
|
3869
|
+
# Creates a Schema.
|
3870
|
+
# @param [String] parent
|
3871
|
+
# Required. The parent data store resource name, in the format of `projects/`
|
3872
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store``
|
3873
|
+
# .
|
3874
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
|
3875
|
+
# @param [String] schema_id
|
3876
|
+
# Required. The ID to use for the Schema, which will become the final component
|
3877
|
+
# of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
|
3878
|
+
# org/html/rfc1034) standard with a length limit of 63 characters.
|
2366
3879
|
# @param [String] fields
|
2367
3880
|
# Selector specifying which fields to include in a partial response.
|
2368
3881
|
# @param [String] quota_user
|
@@ -2372,33 +3885,32 @@ module Google
|
|
2372
3885
|
# Request-specific options
|
2373
3886
|
#
|
2374
3887
|
# @yield [result, err] Result & error if block supplied
|
2375
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3888
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2376
3889
|
# @yieldparam err [StandardError] error object if request failed
|
2377
3890
|
#
|
2378
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3891
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2379
3892
|
#
|
2380
3893
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2381
3894
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2382
3895
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2383
|
-
def
|
2384
|
-
command = make_simple_command(:post, 'v1beta/{+
|
2385
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
2386
|
-
command.request_object =
|
2387
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
2388
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
2389
|
-
command.params['
|
3896
|
+
def create_project_location_data_store_schema(parent, google_cloud_discoveryengine_v1beta_schema_object = nil, schema_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3897
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/schemas', options)
|
3898
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema::Representation
|
3899
|
+
command.request_object = google_cloud_discoveryengine_v1beta_schema_object
|
3900
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
3901
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
3902
|
+
command.params['parent'] = parent unless parent.nil?
|
3903
|
+
command.query['schemaId'] = schema_id unless schema_id.nil?
|
2390
3904
|
command.query['fields'] = fields unless fields.nil?
|
2391
3905
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2392
3906
|
execute_or_queue_command(command, &block)
|
2393
3907
|
end
|
2394
3908
|
|
2395
|
-
#
|
2396
|
-
#
|
2397
|
-
#
|
2398
|
-
#
|
2399
|
-
#
|
2400
|
-
# data_store_id``
|
2401
|
-
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
|
3909
|
+
# Deletes a Schema.
|
3910
|
+
# @param [String] name
|
3911
|
+
# Required. The full resource name of the schema, in the format of `projects/`
|
3912
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
3913
|
+
# schemas/`schema``.
|
2402
3914
|
# @param [String] fields
|
2403
3915
|
# Selector specifying which fields to include in a partial response.
|
2404
3916
|
# @param [String] quota_user
|
@@ -2408,32 +3920,29 @@ module Google
|
|
2408
3920
|
# Request-specific options
|
2409
3921
|
#
|
2410
3922
|
# @yield [result, err] Result & error if block supplied
|
2411
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3923
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2412
3924
|
# @yieldparam err [StandardError] error object if request failed
|
2413
3925
|
#
|
2414
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3926
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2415
3927
|
#
|
2416
3928
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2417
3929
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2418
3930
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2419
|
-
def
|
2420
|
-
command = make_simple_command(:
|
2421
|
-
command.
|
2422
|
-
command.
|
2423
|
-
command.
|
2424
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
|
2425
|
-
command.params['parent'] = parent unless parent.nil?
|
3931
|
+
def delete_project_location_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
|
3932
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
3933
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
3934
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
3935
|
+
command.params['name'] = name unless name.nil?
|
2426
3936
|
command.query['fields'] = fields unless fields.nil?
|
2427
3937
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2428
3938
|
execute_or_queue_command(command, &block)
|
2429
3939
|
end
|
2430
3940
|
|
2431
|
-
#
|
2432
|
-
# NOT_FOUND error is returned.
|
3941
|
+
# Gets a Schema.
|
2433
3942
|
# @param [String] name
|
2434
|
-
# Required. The resource name of the
|
2435
|
-
#
|
2436
|
-
#
|
3943
|
+
# Required. The full resource name of the schema, in the format of `projects/`
|
3944
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
3945
|
+
# schemas/`schema``.
|
2437
3946
|
# @param [String] fields
|
2438
3947
|
# Selector specifying which fields to include in a partial response.
|
2439
3948
|
# @param [String] quota_user
|
@@ -2443,29 +3952,77 @@ module Google
|
|
2443
3952
|
# Request-specific options
|
2444
3953
|
#
|
2445
3954
|
# @yield [result, err] Result & error if block supplied
|
2446
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3955
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] parsed result object
|
2447
3956
|
# @yieldparam err [StandardError] error object if request failed
|
2448
3957
|
#
|
2449
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3958
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema]
|
2450
3959
|
#
|
2451
3960
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2452
3961
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2453
3962
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2454
|
-
def
|
2455
|
-
command = make_simple_command(:
|
2456
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
2457
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
3963
|
+
def get_project_location_data_store_schema(name, fields: nil, quota_user: nil, options: nil, &block)
|
3964
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
3965
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema::Representation
|
3966
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema
|
2458
3967
|
command.params['name'] = name unless name.nil?
|
2459
3968
|
command.query['fields'] = fields unless fields.nil?
|
2460
3969
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2461
3970
|
execute_or_queue_command(command, &block)
|
2462
3971
|
end
|
2463
3972
|
|
2464
|
-
# Gets a
|
3973
|
+
# Gets a list of Schemas.
|
3974
|
+
# @param [String] parent
|
3975
|
+
# Required. The parent data store resource name, in the format of `projects/`
|
3976
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store``
|
3977
|
+
# .
|
3978
|
+
# @param [Fixnum] page_size
|
3979
|
+
# The maximum number of Schemas to return. The service may return fewer than
|
3980
|
+
# this value. If unspecified, at most 100 Schemas will be returned. The maximum
|
3981
|
+
# value is 1000; values above 1000 will be coerced to 1000.
|
3982
|
+
# @param [String] page_token
|
3983
|
+
# A page token, received from a previous SchemaService.ListSchemas call. Provide
|
3984
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
3985
|
+
# provided to SchemaService.ListSchemas must match the call that provided the
|
3986
|
+
# page token.
|
3987
|
+
# @param [String] fields
|
3988
|
+
# Selector specifying which fields to include in a partial response.
|
3989
|
+
# @param [String] quota_user
|
3990
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3991
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3992
|
+
# @param [Google::Apis::RequestOptions] options
|
3993
|
+
# Request-specific options
|
3994
|
+
#
|
3995
|
+
# @yield [result, err] Result & error if block supplied
|
3996
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse] parsed result object
|
3997
|
+
# @yieldparam err [StandardError] error object if request failed
|
3998
|
+
#
|
3999
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse]
|
4000
|
+
#
|
4001
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4002
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4003
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4004
|
+
def list_project_location_data_store_schemas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4005
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/schemas', options)
|
4006
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse::Representation
|
4007
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSchemasResponse
|
4008
|
+
command.params['parent'] = parent unless parent.nil?
|
4009
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
4010
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
4011
|
+
command.query['fields'] = fields unless fields.nil?
|
4012
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4013
|
+
execute_or_queue_command(command, &block)
|
4014
|
+
end
|
4015
|
+
|
4016
|
+
# Updates a Schema.
|
2465
4017
|
# @param [String] name
|
2466
|
-
#
|
2467
|
-
#
|
2468
|
-
#
|
4018
|
+
# Immutable. The full resource name of the schema, in the format of `projects/`
|
4019
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
4020
|
+
# schemas/`schema``. This field must be a UTF-8 encoded string with a length
|
4021
|
+
# limit of 1024 characters.
|
4022
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
|
4023
|
+
# @param [Boolean] allow_missing
|
4024
|
+
# If set to true, and the Schema is not found, a new Schema will be created. In
|
4025
|
+
# this situation, `update_mask` is ignored.
|
2469
4026
|
# @param [String] fields
|
2470
4027
|
# Selector specifying which fields to include in a partial response.
|
2471
4028
|
# @param [String] quota_user
|
@@ -2475,41 +4032,38 @@ module Google
|
|
2475
4032
|
# Request-specific options
|
2476
4033
|
#
|
2477
4034
|
# @yield [result, err] Result & error if block supplied
|
2478
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
4035
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2479
4036
|
# @yieldparam err [StandardError] error object if request failed
|
2480
4037
|
#
|
2481
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
4038
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2482
4039
|
#
|
2483
4040
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2484
4041
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2485
4042
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2486
|
-
def
|
2487
|
-
command = make_simple_command(:
|
2488
|
-
command.
|
2489
|
-
command.
|
4043
|
+
def patch_project_location_data_store_schema(name, google_cloud_discoveryengine_v1beta_schema_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4044
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
4045
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema::Representation
|
4046
|
+
command.request_object = google_cloud_discoveryengine_v1beta_schema_object
|
4047
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
4048
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2490
4049
|
command.params['name'] = name unless name.nil?
|
4050
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
2491
4051
|
command.query['fields'] = fields unless fields.nil?
|
2492
4052
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2493
4053
|
execute_or_queue_command(command, &block)
|
2494
4054
|
end
|
2495
4055
|
|
2496
|
-
#
|
2497
|
-
# @param [String]
|
2498
|
-
# Required.
|
2499
|
-
# locations
|
2500
|
-
#
|
2501
|
-
#
|
2502
|
-
#
|
2503
|
-
#
|
2504
|
-
#
|
2505
|
-
#
|
2506
|
-
#
|
2507
|
-
# @param [Fixnum] page_size
|
2508
|
-
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
2509
|
-
# allowed value is 1000.
|
2510
|
-
# @param [String] page_token
|
2511
|
-
# A page token, received from a previous `ListConversations` call. Provide this
|
2512
|
-
# to retrieve the subsequent page.
|
4056
|
+
# Makes a recommendation, which requires a contextual user event.
|
4057
|
+
# @param [String] serving_config
|
4058
|
+
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
4059
|
+
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
4060
|
+
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
4061
|
+
# created along with your recommendation engine creation. The engine ID will be
|
4062
|
+
# used as the ID of the default serving config. For example, for Engine `
|
4063
|
+
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
4064
|
+
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
4065
|
+
# engine` for your RecommendationService.Recommend requests.
|
4066
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
2513
4067
|
# @param [String] fields
|
2514
4068
|
# Selector specifying which fields to include in a partial response.
|
2515
4069
|
# @param [String] quota_user
|
@@ -2519,39 +4073,35 @@ module Google
|
|
2519
4073
|
# Request-specific options
|
2520
4074
|
#
|
2521
4075
|
# @yield [result, err] Result & error if block supplied
|
2522
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
4076
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse] parsed result object
|
2523
4077
|
# @yieldparam err [StandardError] error object if request failed
|
2524
4078
|
#
|
2525
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
4079
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse]
|
2526
4080
|
#
|
2527
4081
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2528
4082
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2529
4083
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2530
|
-
def
|
2531
|
-
command = make_simple_command(:
|
2532
|
-
command.
|
2533
|
-
command.
|
2534
|
-
command.
|
2535
|
-
command.
|
2536
|
-
command.
|
2537
|
-
command.query['pageSize'] = page_size unless page_size.nil?
|
2538
|
-
command.query['pageToken'] = page_token unless page_token.nil?
|
4084
|
+
def recommend_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1beta_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4085
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:recommend', options)
|
4086
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest::Representation
|
4087
|
+
command.request_object = google_cloud_discoveryengine_v1beta_recommend_request_object
|
4088
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse::Representation
|
4089
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse
|
4090
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
2539
4091
|
command.query['fields'] = fields unless fields.nil?
|
2540
4092
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2541
4093
|
execute_or_queue_command(command, &block)
|
2542
4094
|
end
|
2543
4095
|
|
2544
|
-
#
|
2545
|
-
#
|
2546
|
-
#
|
2547
|
-
#
|
2548
|
-
#
|
2549
|
-
#
|
2550
|
-
#
|
2551
|
-
#
|
2552
|
-
#
|
2553
|
-
# are NOT supported: * conversation.name If not set or empty, all supported
|
2554
|
-
# fields are updated.
|
4096
|
+
# Performs a search.
|
4097
|
+
# @param [String] serving_config
|
4098
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
4099
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
4100
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
4101
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
4102
|
+
# default_serving_config`. This field is used to identify the serving
|
4103
|
+
# configuration name, set of models used to make the search.
|
4104
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
2555
4105
|
# @param [String] fields
|
2556
4106
|
# Selector specifying which fields to include in a partial response.
|
2557
4107
|
# @param [String] quota_user
|
@@ -2561,31 +4111,31 @@ module Google
|
|
2561
4111
|
# Request-specific options
|
2562
4112
|
#
|
2563
4113
|
# @yield [result, err] Result & error if block supplied
|
2564
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
4114
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse] parsed result object
|
2565
4115
|
# @yieldparam err [StandardError] error object if request failed
|
2566
4116
|
#
|
2567
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
4117
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse]
|
2568
4118
|
#
|
2569
4119
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2570
4120
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2571
4121
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2572
|
-
def
|
2573
|
-
command = make_simple_command(:
|
2574
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
2575
|
-
command.request_object =
|
2576
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
2577
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
2578
|
-
command.params['
|
2579
|
-
command.query['updateMask'] = update_mask unless update_mask.nil?
|
4122
|
+
def search_project_location_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4123
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:search', options)
|
4124
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest::Representation
|
4125
|
+
command.request_object = google_cloud_discoveryengine_v1beta_search_request_object
|
4126
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse::Representation
|
4127
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
|
4128
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
2580
4129
|
command.query['fields'] = fields unless fields.nil?
|
2581
4130
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2582
4131
|
execute_or_queue_command(command, &block)
|
2583
4132
|
end
|
2584
4133
|
|
2585
|
-
#
|
2586
|
-
#
|
2587
|
-
#
|
2588
|
-
#
|
4134
|
+
# Downgrade from advanced site search to basic site search.
|
4135
|
+
# @param [String] site_search_engine
|
4136
|
+
# Required. Full resource name of the SiteSearchEngine, such as `projects/`
|
4137
|
+
# project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
|
4138
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1beta_disable_advanced_site_search_request_object
|
2589
4139
|
# @param [String] fields
|
2590
4140
|
# Selector specifying which fields to include in a partial response.
|
2591
4141
|
# @param [String] quota_user
|
@@ -2603,26 +4153,23 @@ module Google
|
|
2603
4153
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2604
4154
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2605
4155
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2606
|
-
def
|
2607
|
-
command = make_simple_command(:
|
4156
|
+
def disable_project_location_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1beta_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4157
|
+
command = make_simple_command(:post, 'v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
|
4158
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest::Representation
|
4159
|
+
command.request_object = google_cloud_discoveryengine_v1beta_disable_advanced_site_search_request_object
|
2608
4160
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2609
4161
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2610
|
-
command.params['
|
4162
|
+
command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
|
2611
4163
|
command.query['fields'] = fields unless fields.nil?
|
2612
4164
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2613
4165
|
execute_or_queue_command(command, &block)
|
2614
4166
|
end
|
2615
4167
|
|
2616
|
-
#
|
2617
|
-
#
|
2618
|
-
#
|
2619
|
-
#
|
2620
|
-
# @param [
|
2621
|
-
# The standard list filter.
|
2622
|
-
# @param [Fixnum] page_size
|
2623
|
-
# The standard list page size.
|
2624
|
-
# @param [String] page_token
|
2625
|
-
# The standard list page token.
|
4168
|
+
# Upgrade from basic site search to advanced site search.
|
4169
|
+
# @param [String] site_search_engine
|
4170
|
+
# Required. Full resource name of the SiteSearchEngine, such as `projects/`
|
4171
|
+
# project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
|
4172
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1beta_enable_advanced_site_search_request_object
|
2626
4173
|
# @param [String] fields
|
2627
4174
|
# Selector specifying which fields to include in a partial response.
|
2628
4175
|
# @param [String] quota_user
|
@@ -2632,31 +4179,31 @@ module Google
|
|
2632
4179
|
# Request-specific options
|
2633
4180
|
#
|
2634
4181
|
# @yield [result, err] Result & error if block supplied
|
2635
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
4182
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2636
4183
|
# @yieldparam err [StandardError] error object if request failed
|
2637
4184
|
#
|
2638
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
4185
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2639
4186
|
#
|
2640
4187
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2641
4188
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2642
4189
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2643
|
-
def
|
2644
|
-
command = make_simple_command(:
|
2645
|
-
command.
|
2646
|
-
command.
|
2647
|
-
command.
|
2648
|
-
command.
|
2649
|
-
command.
|
2650
|
-
command.query['pageToken'] = page_token unless page_token.nil?
|
4190
|
+
def enable_project_location_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1beta_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4191
|
+
command = make_simple_command(:post, 'v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
|
4192
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest::Representation
|
4193
|
+
command.request_object = google_cloud_discoveryengine_v1beta_enable_advanced_site_search_request_object
|
4194
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
4195
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
4196
|
+
command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
|
2651
4197
|
command.query['fields'] = fields unless fields.nil?
|
2652
4198
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2653
4199
|
execute_or_queue_command(command, &block)
|
2654
4200
|
end
|
2655
4201
|
|
2656
|
-
#
|
2657
|
-
#
|
2658
|
-
#
|
2659
|
-
#
|
4202
|
+
# Request on-demand recrawl for a list of URIs.
|
4203
|
+
# @param [String] site_search_engine
|
4204
|
+
# Required. Full resource name of the SiteSearchEngine, such as `projects/*/
|
4205
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
4206
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest] google_cloud_discoveryengine_v1beta_recrawl_uris_request_object
|
2660
4207
|
# @param [String] fields
|
2661
4208
|
# Selector specifying which fields to include in a partial response.
|
2662
4209
|
# @param [String] quota_user
|
@@ -2674,26 +4221,25 @@ module Google
|
|
2674
4221
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2675
4222
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2676
4223
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2677
|
-
def
|
2678
|
-
command = make_simple_command(:
|
4224
|
+
def recrawl_project_location_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1beta_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4225
|
+
command = make_simple_command(:post, 'v1beta/{+siteSearchEngine}:recrawlUris', options)
|
4226
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest::Representation
|
4227
|
+
command.request_object = google_cloud_discoveryengine_v1beta_recrawl_uris_request_object
|
2679
4228
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2680
4229
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2681
|
-
command.params['
|
4230
|
+
command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
|
2682
4231
|
command.query['fields'] = fields unless fields.nil?
|
2683
4232
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2684
4233
|
execute_or_queue_command(command, &block)
|
2685
4234
|
end
|
2686
4235
|
|
2687
|
-
#
|
2688
|
-
#
|
2689
|
-
#
|
2690
|
-
#
|
2691
|
-
#
|
2692
|
-
#
|
2693
|
-
# @param [
|
2694
|
-
# The standard list page size.
|
2695
|
-
# @param [String] page_token
|
2696
|
-
# The standard list page token.
|
4236
|
+
# Creates TargetSite in a batch.
|
4237
|
+
# @param [String] parent
|
4238
|
+
# Required. The parent resource shared by all TargetSites being created. `
|
4239
|
+
# projects/`project`/locations/`location`/collections/`collection`/dataStores/`
|
4240
|
+
# data_store`/siteSearchEngine`. The parent field in the CreateBookRequest
|
4241
|
+
# messages must either be empty or match this field.
|
4242
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest] google_cloud_discoveryengine_v1beta_batch_create_target_sites_request_object
|
2697
4243
|
# @param [String] fields
|
2698
4244
|
# Selector specifying which fields to include in a partial response.
|
2699
4245
|
# @param [String] quota_user
|
@@ -2703,37 +4249,32 @@ module Google
|
|
2703
4249
|
# Request-specific options
|
2704
4250
|
#
|
2705
4251
|
# @yield [result, err] Result & error if block supplied
|
2706
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
4252
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2707
4253
|
# @yieldparam err [StandardError] error object if request failed
|
2708
4254
|
#
|
2709
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
4255
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2710
4256
|
#
|
2711
4257
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2712
4258
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2713
4259
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2714
|
-
def
|
2715
|
-
command = make_simple_command(:
|
2716
|
-
command.
|
2717
|
-
command.
|
2718
|
-
command.
|
2719
|
-
command.
|
2720
|
-
command.
|
2721
|
-
command.query['pageToken'] = page_token unless page_token.nil?
|
4260
|
+
def batch_project_location_data_store_site_search_engine_target_site_create(parent, google_cloud_discoveryengine_v1beta_batch_create_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4261
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/targetSites:batchCreate', options)
|
4262
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest::Representation
|
4263
|
+
command.request_object = google_cloud_discoveryengine_v1beta_batch_create_target_sites_request_object
|
4264
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
4265
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
4266
|
+
command.params['parent'] = parent unless parent.nil?
|
2722
4267
|
command.query['fields'] = fields unless fields.nil?
|
2723
4268
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2724
4269
|
execute_or_queue_command(command, &block)
|
2725
4270
|
end
|
2726
4271
|
|
2727
|
-
# Creates a
|
4272
|
+
# Creates a TargetSite.
|
2728
4273
|
# @param [String] parent
|
2729
|
-
# Required.
|
2730
|
-
#
|
2731
|
-
#
|
2732
|
-
# @param [Google::Apis::DiscoveryengineV1beta::
|
2733
|
-
# @param [String] schema_id
|
2734
|
-
# Required. The ID to use for the Schema, which will become the final component
|
2735
|
-
# of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
|
2736
|
-
# org/html/rfc1034) standard with a length limit of 63 characters.
|
4274
|
+
# Required. Parent resource name of TargetSite, such as `projects/`project`/
|
4275
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/
|
4276
|
+
# siteSearchEngine`.
|
4277
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite] google_cloud_discoveryengine_v1beta_target_site_object
|
2737
4278
|
# @param [String] fields
|
2738
4279
|
# Selector specifying which fields to include in a partial response.
|
2739
4280
|
# @param [String] quota_user
|
@@ -2751,24 +4292,26 @@ module Google
|
|
2751
4292
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2752
4293
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2753
4294
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2754
|
-
def
|
2755
|
-
command = make_simple_command(:post, 'v1beta/{+parent}/
|
2756
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
2757
|
-
command.request_object =
|
4295
|
+
def create_project_location_data_store_site_search_engine_target_site(parent, google_cloud_discoveryengine_v1beta_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4296
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/targetSites', options)
|
4297
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite::Representation
|
4298
|
+
command.request_object = google_cloud_discoveryengine_v1beta_target_site_object
|
2758
4299
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2759
4300
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2760
4301
|
command.params['parent'] = parent unless parent.nil?
|
2761
|
-
command.query['schemaId'] = schema_id unless schema_id.nil?
|
2762
4302
|
command.query['fields'] = fields unless fields.nil?
|
2763
4303
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2764
4304
|
execute_or_queue_command(command, &block)
|
2765
4305
|
end
|
2766
4306
|
|
2767
|
-
# Deletes a
|
4307
|
+
# Deletes a TargetSite.
|
2768
4308
|
# @param [String] name
|
2769
|
-
# Required.
|
2770
|
-
#
|
2771
|
-
#
|
4309
|
+
# Required. Full resource name of TargetSite, such as `projects/`project`/
|
4310
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/
|
4311
|
+
# siteSearchEngine/targetSites/`target_site``. If the caller does not have
|
4312
|
+
# permission to access the TargetSite, regardless of whether or not it exists, a
|
4313
|
+
# PERMISSION_DENIED error is returned. If the requested TargetSite does not
|
4314
|
+
# exist, a NOT_FOUND error is returned.
|
2772
4315
|
# @param [String] fields
|
2773
4316
|
# Selector specifying which fields to include in a partial response.
|
2774
4317
|
# @param [String] quota_user
|
@@ -2786,7 +4329,7 @@ module Google
|
|
2786
4329
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2787
4330
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2788
4331
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2789
|
-
def
|
4332
|
+
def delete_project_location_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
|
2790
4333
|
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
2791
4334
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2792
4335
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
@@ -2796,11 +4339,14 @@ module Google
|
|
2796
4339
|
execute_or_queue_command(command, &block)
|
2797
4340
|
end
|
2798
4341
|
|
2799
|
-
# Gets a
|
4342
|
+
# Gets a TargetSite.
|
2800
4343
|
# @param [String] name
|
2801
|
-
# Required.
|
2802
|
-
#
|
2803
|
-
#
|
4344
|
+
# Required. Full resource name of TargetSite, such as `projects/`project`/
|
4345
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/
|
4346
|
+
# siteSearchEngine/targetSites/`target_site``. If the caller does not have
|
4347
|
+
# permission to access the TargetSite, regardless of whether or not it exists, a
|
4348
|
+
# PERMISSION_DENIED error is returned. If the requested TargetSite does not
|
4349
|
+
# exist, a NOT_FOUND error is returned.
|
2804
4350
|
# @param [String] fields
|
2805
4351
|
# Selector specifying which fields to include in a partial response.
|
2806
4352
|
# @param [String] quota_user
|
@@ -2810,38 +4356,40 @@ module Google
|
|
2810
4356
|
# Request-specific options
|
2811
4357
|
#
|
2812
4358
|
# @yield [result, err] Result & error if block supplied
|
2813
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
4359
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite] parsed result object
|
2814
4360
|
# @yieldparam err [StandardError] error object if request failed
|
2815
4361
|
#
|
2816
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
4362
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite]
|
2817
4363
|
#
|
2818
4364
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2819
4365
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2820
4366
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2821
|
-
def
|
4367
|
+
def get_project_location_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
|
2822
4368
|
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
2823
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
2824
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
4369
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite::Representation
|
4370
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite
|
2825
4371
|
command.params['name'] = name unless name.nil?
|
2826
4372
|
command.query['fields'] = fields unless fields.nil?
|
2827
4373
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2828
4374
|
execute_or_queue_command(command, &block)
|
2829
4375
|
end
|
2830
4376
|
|
2831
|
-
# Gets a list of
|
4377
|
+
# Gets a list of TargetSites.
|
2832
4378
|
# @param [String] parent
|
2833
|
-
# Required. The parent
|
2834
|
-
# project`/locations/`location`/collections/`collection`/dataStores/`data_store
|
2835
|
-
#
|
4379
|
+
# Required. The parent site search engine resource name, such as `projects/`
|
4380
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
4381
|
+
# siteSearchEngine`. If the caller does not have permission to list TargetSites
|
4382
|
+
# under this site search engine, regardless of whether or not this branch exists,
|
4383
|
+
# a PERMISSION_DENIED error is returned.
|
2836
4384
|
# @param [Fixnum] page_size
|
2837
|
-
#
|
2838
|
-
#
|
2839
|
-
#
|
4385
|
+
# Requested page size. Server may return fewer items than requested. If
|
4386
|
+
# unspecified, server will pick an appropriate default. The maximum value is
|
4387
|
+
# 1000; values above 1000 will be coerced to 1000. If this field is negative, an
|
4388
|
+
# INVALID_ARGUMENT error is returned.
|
2840
4389
|
# @param [String] page_token
|
2841
|
-
# A page token, received from a previous
|
2842
|
-
#
|
2843
|
-
#
|
2844
|
-
# page token.
|
4390
|
+
# A page token, received from a previous `ListTargetSites` call. Provide this to
|
4391
|
+
# retrieve the subsequent page. When paginating, all other parameters provided
|
4392
|
+
# to `ListTargetSites` must match the call that provided the page token.
|
2845
4393
|
# @param [String] fields
|
2846
4394
|
# Selector specifying which fields to include in a partial response.
|
2847
4395
|
# @param [String] quota_user
|
@@ -2851,18 +4399,18 @@ module Google
|
|
2851
4399
|
# Request-specific options
|
2852
4400
|
#
|
2853
4401
|
# @yield [result, err] Result & error if block supplied
|
2854
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
4402
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListTargetSitesResponse] parsed result object
|
2855
4403
|
# @yieldparam err [StandardError] error object if request failed
|
2856
4404
|
#
|
2857
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
4405
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListTargetSitesResponse]
|
2858
4406
|
#
|
2859
4407
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2860
4408
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2861
4409
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2862
|
-
def
|
2863
|
-
command = make_simple_command(:get, 'v1beta/{+parent}/
|
2864
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
2865
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
4410
|
+
def list_project_location_data_store_site_search_engine_target_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4411
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/targetSites', options)
|
4412
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListTargetSitesResponse::Representation
|
4413
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListTargetSitesResponse
|
2866
4414
|
command.params['parent'] = parent unless parent.nil?
|
2867
4415
|
command.query['pageSize'] = page_size unless page_size.nil?
|
2868
4416
|
command.query['pageToken'] = page_token unless page_token.nil?
|
@@ -2871,16 +4419,13 @@ module Google
|
|
2871
4419
|
execute_or_queue_command(command, &block)
|
2872
4420
|
end
|
2873
4421
|
|
2874
|
-
# Updates a
|
4422
|
+
# Updates a TargetSite.
|
2875
4423
|
# @param [String] name
|
2876
|
-
#
|
4424
|
+
# Output only. The fully qualified resource name of the target site. `projects/`
|
2877
4425
|
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
2878
|
-
#
|
2879
|
-
#
|
2880
|
-
# @param [Google::Apis::DiscoveryengineV1beta::
|
2881
|
-
# @param [Boolean] allow_missing
|
2882
|
-
# If set to true, and the Schema is not found, a new Schema will be created. In
|
2883
|
-
# this situation, `update_mask` is ignored.
|
4426
|
+
# siteSearchEngine/targetSites/`target_site`` The `target_site_id` is system-
|
4427
|
+
# generated.
|
4428
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite] google_cloud_discoveryengine_v1beta_target_site_object
|
2884
4429
|
# @param [String] fields
|
2885
4430
|
# Selector specifying which fields to include in a partial response.
|
2886
4431
|
# @param [String] quota_user
|
@@ -2898,30 +4443,23 @@ module Google
|
|
2898
4443
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2899
4444
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2900
4445
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2901
|
-
def
|
4446
|
+
def patch_project_location_data_store_site_search_engine_target_site(name, google_cloud_discoveryengine_v1beta_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2902
4447
|
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
2903
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
2904
|
-
command.request_object =
|
4448
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite::Representation
|
4449
|
+
command.request_object = google_cloud_discoveryengine_v1beta_target_site_object
|
2905
4450
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
2906
4451
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
2907
4452
|
command.params['name'] = name unless name.nil?
|
2908
|
-
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
2909
4453
|
command.query['fields'] = fields unless fields.nil?
|
2910
4454
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2911
4455
|
execute_or_queue_command(command, &block)
|
2912
4456
|
end
|
2913
4457
|
|
2914
|
-
#
|
2915
|
-
# @param [String]
|
2916
|
-
# Required.
|
2917
|
-
#
|
2918
|
-
#
|
2919
|
-
# created along with your recommendation engine creation. The engine ID will be
|
2920
|
-
# used as the ID of the default serving config. For example, for Engine `
|
2921
|
-
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
2922
|
-
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
2923
|
-
# engine` for your Recommend requests.
|
2924
|
-
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
4458
|
+
# Imports all SuggestionDenyListEntry for a DataStore.
|
4459
|
+
# @param [String] parent
|
4460
|
+
# Required. The parent data store resource name for which to import denylist
|
4461
|
+
# entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
|
4462
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest] google_cloud_discoveryengine_v1beta_import_suggestion_deny_list_entries_request_object
|
2925
4463
|
# @param [String] fields
|
2926
4464
|
# Selector specifying which fields to include in a partial response.
|
2927
4465
|
# @param [String] quota_user
|
@@ -2931,35 +4469,31 @@ module Google
|
|
2931
4469
|
# Request-specific options
|
2932
4470
|
#
|
2933
4471
|
# @yield [result, err] Result & error if block supplied
|
2934
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
4472
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2935
4473
|
# @yieldparam err [StandardError] error object if request failed
|
2936
4474
|
#
|
2937
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
4475
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2938
4476
|
#
|
2939
4477
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2940
4478
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2941
4479
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2942
|
-
def
|
2943
|
-
command = make_simple_command(:post, 'v1beta/{+
|
2944
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
2945
|
-
command.request_object =
|
2946
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
2947
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
2948
|
-
command.params['
|
4480
|
+
def import_project_location_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1beta_import_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4481
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/suggestionDenyListEntries:import', options)
|
4482
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest::Representation
|
4483
|
+
command.request_object = google_cloud_discoveryengine_v1beta_import_suggestion_deny_list_entries_request_object
|
4484
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
4485
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
4486
|
+
command.params['parent'] = parent unless parent.nil?
|
2949
4487
|
command.query['fields'] = fields unless fields.nil?
|
2950
4488
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2951
4489
|
execute_or_queue_command(command, &block)
|
2952
4490
|
end
|
2953
4491
|
|
2954
|
-
#
|
2955
|
-
# @param [String]
|
2956
|
-
# Required. The
|
2957
|
-
# locations
|
2958
|
-
#
|
2959
|
-
# default_collection/dataStores/default_data_store/servingConfigs/
|
2960
|
-
# default_serving_config`. This field is used to identify the serving
|
2961
|
-
# configuration name, set of models used to make the search.
|
2962
|
-
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
4492
|
+
# Permanently deletes all SuggestionDenyListEntry for a DataStore.
|
4493
|
+
# @param [String] parent
|
4494
|
+
# Required. The parent data store resource name for which to import denylist
|
4495
|
+
# entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
|
4496
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest] google_cloud_discoveryengine_v1beta_purge_suggestion_deny_list_entries_request_object
|
2963
4497
|
# @param [String] fields
|
2964
4498
|
# Selector specifying which fields to include in a partial response.
|
2965
4499
|
# @param [String] quota_user
|
@@ -2969,21 +4503,21 @@ module Google
|
|
2969
4503
|
# Request-specific options
|
2970
4504
|
#
|
2971
4505
|
# @yield [result, err] Result & error if block supplied
|
2972
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
4506
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
2973
4507
|
# @yieldparam err [StandardError] error object if request failed
|
2974
4508
|
#
|
2975
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
4509
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
2976
4510
|
#
|
2977
4511
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2978
4512
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2979
4513
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2980
|
-
def
|
2981
|
-
command = make_simple_command(:post, 'v1beta/{+
|
2982
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
2983
|
-
command.request_object =
|
2984
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
2985
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
2986
|
-
command.params['
|
4514
|
+
def purge_project_location_data_store_suggestion_deny_list_entry(parent, google_cloud_discoveryengine_v1beta_purge_suggestion_deny_list_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4515
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/suggestionDenyListEntries:purge', options)
|
4516
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest::Representation
|
4517
|
+
command.request_object = google_cloud_discoveryengine_v1beta_purge_suggestion_deny_list_entries_request_object
|
4518
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
4519
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
4520
|
+
command.params['parent'] = parent unless parent.nil?
|
2987
4521
|
command.query['fields'] = fields unless fields.nil?
|
2988
4522
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2989
4523
|
execute_or_queue_command(command, &block)
|