google-apis-discoveryengine_v1beta 0.49.0 → 0.51.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (9) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -0
  3. data/OVERVIEW.md +1 -1
  4. data/lib/google/apis/discoveryengine_v1beta/classes.rb +6439 -573
  5. data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +3 -3
  6. data/lib/google/apis/discoveryengine_v1beta/representations.rb +3457 -1037
  7. data/lib/google/apis/discoveryengine_v1beta/service.rb +1565 -207
  8. data/lib/google/apis/discoveryengine_v1beta.rb +1 -1
  9. metadata +4 -4
data/lib/google/apis/discoveryengine_v1beta/service.rb CHANGED
@@ -30,7 +30,7 @@ module Google
30
30
  # Discoveryengine = Google::Apis::DiscoveryengineV1beta # Alias the module
31
31
  # service = Discoveryengine::DiscoveryEngineService.new
32
32
  #
33
- # @see https://cloud.google.com/discovery-engine/docs
33
+ # @see https://cloud.google.com/generative-ai-app-builder/docs/
34
34
  class DiscoveryEngineService < Google::Apis::Core::BaseService
35
35
  DEFAULT_ENDPOINT_TEMPLATE = "https://discoveryengine.$UNIVERSE_DOMAIN$/"
36
36
 
@@ -229,6 +229,8 @@ module Google
229
229
  # Required. The parent resource name, such as `projects/`project`/locations/`
230
230
  # location`/collections/`collection``.
231
231
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore] google_cloud_discoveryengine_v1beta_data_store_object
232
+ # @param [String] cmek_config_name
233
+ # Resource name of the CmekConfig to use for protecting this DataStore.
232
234
  # @param [Boolean] create_advanced_site_search
233
235
  # A boolean flag indicating whether user want to directly create an advanced
234
236
  # data store for site search. If the data store is not configured as site search
@@ -239,6 +241,15 @@ module Google
239
241
  # component of the DataStore's resource name. This field must conform to [RFC-
240
242
  # 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
241
243
  # characters. Otherwise, an INVALID_ARGUMENT error is returned.
244
+ # @param [Boolean] disable_cmek
245
+ # DataStore without CMEK protections. If a default CmekConfig is set for the
246
+ # project, setting this field will override the default CmekConfig as well.
247
+ # @param [Boolean] skip_default_schema_creation
248
+ # A boolean flag indicating whether to skip the default schema creation for the
249
+ # data store. Only enable this flag if you are certain that the default schema
250
+ # is incompatible with your use case. If set to true, you must manually create a
251
+ # schema for the data store before any documents can be ingested. This flag
252
+ # cannot be specified if `data_store.starting_schema` is specified.
242
253
  # @param [String] fields
243
254
  # Selector specifying which fields to include in a partial response.
244
255
  # @param [String] quota_user
@@ -256,15 +267,18 @@ module Google
256
267
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
257
268
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
258
269
  # @raise [Google::Apis::AuthorizationError] Authorization is required
259
- 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)
270
+ def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1beta_data_store_object = nil, cmek_config_name: nil, create_advanced_site_search: nil, data_store_id: nil, disable_cmek: nil, skip_default_schema_creation: nil, fields: nil, quota_user: nil, options: nil, &block)
260
271
  command = make_simple_command(:post, 'v1beta/{+parent}/dataStores', options)
261
272
  command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore::Representation
262
273
  command.request_object = google_cloud_discoveryengine_v1beta_data_store_object
263
274
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
264
275
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
265
276
  command.params['parent'] = parent unless parent.nil?
277
+ command.query['cmekConfigName'] = cmek_config_name unless cmek_config_name.nil?
266
278
  command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
267
279
  command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
280
+ command.query['disableCmek'] = disable_cmek unless disable_cmek.nil?
281
+ command.query['skipDefaultSchemaCreation'] = skip_default_schema_creation unless skip_default_schema_creation.nil?
268
282
  command.query['fields'] = fields unless fields.nil?
269
283
  command.query['quotaUser'] = quota_user unless quota_user.nil?
270
284
  execute_or_queue_command(command, &block)
@@ -496,6 +510,46 @@ module Google
496
510
  execute_or_queue_command(command, &block)
497
511
  end
498
512
 
513
+ # Gets index freshness metadata for Documents. Supported for website search only.
514
+ # @param [String] parent
515
+ # Required. The parent branch resource name, such as `projects/`project`/
516
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
517
+ # `branch``.
518
+ # @param [Array<String>, String] matcher_fhir_matcher_fhir_resources
519
+ # Required. The FHIR resources to match by. Format: projects/`project`/locations/
520
+ # `location`/datasets/`dataset`/fhirStores/`fhir_store`/fhir/`resource_type`/`
521
+ # fhir_resource_id`
522
+ # @param [Array<String>, String] matcher_uris_matcher_uris
523
+ # The exact URIs to match by.
524
+ # @param [String] fields
525
+ # Selector specifying which fields to include in a partial response.
526
+ # @param [String] quota_user
527
+ # Available to use for quota purposes for server-side applications. Can be any
528
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
529
+ # @param [Google::Apis::RequestOptions] options
530
+ # Request-specific options
531
+ #
532
+ # @yield [result, err] Result & error if block supplied
533
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse] parsed result object
534
+ # @yieldparam err [StandardError] error object if request failed
535
+ #
536
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse]
537
+ #
538
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
539
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
540
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
541
+ def batch_project_location_collection_data_store_branch_get_documents_metadata(parent, matcher_fhir_matcher_fhir_resources: nil, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
542
+ command = make_simple_command(:get, 'v1beta/{+parent}/batchGetDocumentsMetadata', options)
543
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse::Representation
544
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse
545
+ command.params['parent'] = parent unless parent.nil?
546
+ command.query['matcher.fhirMatcher.fhirResources'] = matcher_fhir_matcher_fhir_resources unless matcher_fhir_matcher_fhir_resources.nil?
547
+ command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
548
+ command.query['fields'] = fields unless fields.nil?
549
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
550
+ execute_or_queue_command(command, &block)
551
+ end
552
+
499
553
  # Creates a Document.
500
554
  # @param [String] parent
501
555
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -782,8 +836,8 @@ module Google
782
836
  # Clients can use Operations.GetOperation or other methods to check whether the
783
837
  # cancellation succeeded or whether the operation completed despite cancellation.
784
838
  # On successful cancellation, the operation is not deleted; instead, it becomes
785
- # an operation with an Operation.error value with a google.rpc.Status.code of 1,
786
- # corresponding to `Code.CANCELLED`.
839
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
840
+ # , corresponding to `Code.CANCELLED`.
787
841
  # @param [String] name
788
842
  # The name of the operation resource to be cancelled.
789
843
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
@@ -887,6 +941,42 @@ module Google
887
941
  execute_or_queue_command(command, &block)
888
942
  end
889
943
 
944
+ # Completes the user input with advanced keyword suggestions.
945
+ # @param [String] completion_config
946
+ # Required. The completion_config of the parent dataStore or engine resource
947
+ # name for which the completion is performed, such as `projects/*/locations/
948
+ # global/collections/default_collection/dataStores/*/completionConfig` `projects/
949
+ # */locations/global/collections/default_collection/engines/*/completionConfig`.
950
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest] google_cloud_discoveryengine_v1beta_advanced_complete_query_request_object
951
+ # @param [String] fields
952
+ # Selector specifying which fields to include in a partial response.
953
+ # @param [String] quota_user
954
+ # Available to use for quota purposes for server-side applications. Can be any
955
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
956
+ # @param [Google::Apis::RequestOptions] options
957
+ # Request-specific options
958
+ #
959
+ # @yield [result, err] Result & error if block supplied
960
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse] parsed result object
961
+ # @yieldparam err [StandardError] error object if request failed
962
+ #
963
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse]
964
+ #
965
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
966
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
967
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
968
+ def complete_project_location_collection_data_store_completion_config_query(completion_config, google_cloud_discoveryengine_v1beta_advanced_complete_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
969
+ command = make_simple_command(:post, 'v1beta/{+completionConfig}:completeQuery', options)
970
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest::Representation
971
+ command.request_object = google_cloud_discoveryengine_v1beta_advanced_complete_query_request_object
972
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse::Representation
973
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse
974
+ command.params['completionConfig'] = completion_config unless completion_config.nil?
975
+ command.query['fields'] = fields unless fields.nil?
976
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
977
+ execute_or_queue_command(command, &block)
978
+ end
979
+
890
980
  # Imports CompletionSuggestions for a DataStore.
891
981
  # @param [String] parent
892
982
  # Required. The parent data store resource name for which to import customer
@@ -960,10 +1050,10 @@ module Google
960
1050
  # request can be submitted to adjust this limit. If the Control to create
961
1051
  # already exists, an ALREADY_EXISTS error is returned.
962
1052
  # @param [String] parent
963
- # Required. Full resource name of parent data store. Format: `projects/`
964
- # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
965
- # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
966
- # collections/`collection_id`/engines/`engine_id``.
1053
+ # Required. Full resource name of parent data store. Format: `projects/`project`/
1054
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``
1055
+ # or `projects/`project`/locations/`location`/collections/`collection_id`/
1056
+ # engines/`engine_id``.
967
1057
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
968
1058
  # @param [String] control_id
969
1059
  # Required. The ID to use for the Control, which will become the final component
@@ -1003,8 +1093,8 @@ module Google
1003
1093
  # is returned.
1004
1094
  # @param [String] name
1005
1095
  # Required. The resource name of the Control to delete. Format: `projects/`
1006
- # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
1007
- # `data_store_id`/controls/`control_id``
1096
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
1097
+ # data_store_id`/controls/`control_id``
1008
1098
  # @param [String] fields
1009
1099
  # Selector specifying which fields to include in a partial response.
1010
1100
  # @param [String] quota_user
@@ -1034,9 +1124,9 @@ module Google
1034
1124
 
1035
1125
  # Gets a Control.
1036
1126
  # @param [String] name
1037
- # Required. The resource name of the Control to get. Format: `projects/`
1038
- # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
1039
- # `data_store_id`/controls/`control_id``
1127
+ # Required. The resource name of the Control to get. Format: `projects/`project`/
1128
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
1129
+ # controls/`control_id``
1040
1130
  # @param [String] fields
1041
1131
  # Selector specifying which fields to include in a partial response.
1042
1132
  # @param [String] quota_user
@@ -1066,10 +1156,10 @@ module Google
1066
1156
 
1067
1157
  # Lists all Controls by their parent DataStore.
1068
1158
  # @param [String] parent
1069
- # Required. The data store resource name. Format: `projects/`project_number`/
1070
- # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
1071
- # or `projects/`project_number`/locations/`location_id`/collections/`
1072
- # collection_id`/engines/`engine_id``.
1159
+ # Required. The data store resource name. Format: `projects/`project`/locations/`
1160
+ # location`/collections/`collection_id`/dataStores/`data_store_id`` or `projects/
1161
+ # `project`/locations/`location`/collections/`collection_id`/engines/`engine_id``
1162
+ # .
1073
1163
  # @param [String] filter
1074
1164
  # Optional. A filter to apply on the list results. Supported features: * List
1075
1165
  # all the products under the parent branch if filter is unset. Currently this
@@ -1153,9 +1243,9 @@ module Google
1153
1243
  # Converses a conversation.
1154
1244
  # @param [String] name
1155
1245
  # Required. The resource name of the Conversation to get. Format: `projects/`
1156
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1157
- # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
1158
- # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
1246
+ # project`/locations/`location`/collections/`collection`/dataStores/`
1247
+ # data_store_id`/conversations/`conversation_id``. Use `projects/`project`/
1248
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id`/
1159
1249
  # conversations/-` to activate auto session mode, which automatically creates a
1160
1250
  # new conversation inside a ConverseConversation session.
1161
1251
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest] google_cloud_discoveryengine_v1beta_converse_conversation_request_object
@@ -1191,9 +1281,8 @@ module Google
1191
1281
  # Creates a Conversation. If the Conversation to create already exists, an
1192
1282
  # ALREADY_EXISTS error is returned.
1193
1283
  # @param [String] parent
1194
- # Required. Full resource name of parent data store. Format: `projects/`
1195
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1196
- # data_store_id``
1284
+ # Required. Full resource name of parent data store. Format: `projects/`project`/
1285
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id``
1197
1286
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
1198
1287
  # @param [String] fields
1199
1288
  # Selector specifying which fields to include in a partial response.
@@ -1228,7 +1317,7 @@ module Google
1228
1317
  # NOT_FOUND error is returned.
1229
1318
  # @param [String] name
1230
1319
  # Required. The resource name of the Conversation to delete. Format: `projects/`
1231
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1320
+ # project`/locations/`location`/collections/`collection`/dataStores/`
1232
1321
  # data_store_id`/conversations/`conversation_id``
1233
1322
  # @param [String] fields
1234
1323
  # Selector specifying which fields to include in a partial response.
@@ -1260,7 +1349,7 @@ module Google
1260
1349
  # Gets a Conversation.
1261
1350
  # @param [String] name
1262
1351
  # Required. The resource name of the Conversation to get. Format: `projects/`
1263
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1352
+ # project`/locations/`location`/collections/`collection`/dataStores/`
1264
1353
  # data_store_id`/conversations/`conversation_id``
1265
1354
  # @param [String] fields
1266
1355
  # Selector specifying which fields to include in a partial response.
@@ -1291,8 +1380,8 @@ module Google
1291
1380
 
1292
1381
  # Lists all Conversations by their parent DataStore.
1293
1382
  # @param [String] parent
1294
- # Required. The data store resource name. Format: `projects/`project_number`/
1295
- # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
1383
+ # Required. The data store resource name. Format: `projects/`project`/locations/`
1384
+ # location`/collections/`collection`/dataStores/`data_store_id``
1296
1385
  # @param [String] filter
1297
1386
  # A filter to apply on the list results. The supported features are:
1298
1387
  # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
@@ -1852,7 +1941,7 @@ module Google
1852
1941
  # exist.
1853
1942
  # @param [String] name
1854
1943
  # Required. The resource name of the ServingConfig to get. Format: `projects/`
1855
- # project_number`/locations/`location`/collections/`collection`/engines/`engine`/
1944
+ # project`/locations/`location`/collections/`collection`/engines/`engine`/
1856
1945
  # servingConfigs/`serving_config_id``
1857
1946
  # @param [String] fields
1858
1947
  # Selector specifying which fields to include in a partial response.
@@ -1884,7 +1973,7 @@ module Google
1884
1973
  # Lists all ServingConfigs linked to this dataStore.
1885
1974
  # @param [String] parent
1886
1975
  # Required. Full resource name of the parent resource. Format: `projects/`
1887
- # project_number`/locations/`location`/collections/`collection`/engines/`engine``
1976
+ # project`/locations/`location`/collections/`collection`/engines/`engine``
1888
1977
  # @param [Fixnum] page_size
1889
1978
  # Optional. Maximum number of results to return. If unspecified, defaults to 100.
1890
1979
  # If a value greater than 100 is provided, at most 100 results are returned.
@@ -2039,12 +2128,56 @@ module Google
2039
2128
  execute_or_queue_command(command, &block)
2040
2129
  end
2041
2130
 
2131
+ # Performs a search. Similar to the SearchService.Search method, but a lite
2132
+ # version that allows API key for authentication, where OAuth and IAM checks are
2133
+ # not required. Only public website search is supported by this method. If data
2134
+ # stores and engines not associated with public website search are specified, a `
2135
+ # FAILED_PRECONDITION` error is returned. This method can be used for easy
2136
+ # onboarding without having to implement an authentication backend. However, it
2137
+ # is strongly recommended to use SearchService.Search instead with required
2138
+ # OAuth and IAM checks to provide better data security.
2139
+ # @param [String] serving_config
2140
+ # Required. The resource name of the Search serving config, such as `projects/*/
2141
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
2142
+ # default_serving_config`, or `projects/*/locations/global/collections/
2143
+ # default_collection/dataStores/default_data_store/servingConfigs/
2144
+ # default_serving_config`. This field is used to identify the serving
2145
+ # configuration name, set of models used to make the search.
2146
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
2147
+ # @param [String] fields
2148
+ # Selector specifying which fields to include in a partial response.
2149
+ # @param [String] quota_user
2150
+ # Available to use for quota purposes for server-side applications. Can be any
2151
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2152
+ # @param [Google::Apis::RequestOptions] options
2153
+ # Request-specific options
2154
+ #
2155
+ # @yield [result, err] Result & error if block supplied
2156
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse] parsed result object
2157
+ # @yieldparam err [StandardError] error object if request failed
2158
+ #
2159
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse]
2160
+ #
2161
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2162
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2163
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2164
+ def search_project_location_collection_data_store_serving_config_lite(serving_config, google_cloud_discoveryengine_v1beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2165
+ command = make_simple_command(:post, 'v1beta/{+servingConfig}:searchLite', options)
2166
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest::Representation
2167
+ command.request_object = google_cloud_discoveryengine_v1beta_search_request_object
2168
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse::Representation
2169
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
2170
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
2171
+ command.query['fields'] = fields unless fields.nil?
2172
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2173
+ execute_or_queue_command(command, &block)
2174
+ end
2175
+
2042
2176
  # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
2043
2177
  # error is returned.
2044
2178
  # @param [String] parent
2045
- # Required. Full resource name of parent data store. Format: `projects/`
2046
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2047
- # data_store_id``
2179
+ # Required. Full resource name of parent data store. Format: `projects/`project`/
2180
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id``
2048
2181
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] google_cloud_discoveryengine_v1beta_session_object
2049
2182
  # @param [String] fields
2050
2183
  # Selector specifying which fields to include in a partial response.
@@ -2079,7 +2212,7 @@ module Google
2079
2212
  # is returned.
2080
2213
  # @param [String] name
2081
2214
  # Required. The resource name of the Session to delete. Format: `projects/`
2082
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2215
+ # project`/locations/`location`/collections/`collection`/dataStores/`
2083
2216
  # data_store_id`/sessions/`session_id``
2084
2217
  # @param [String] fields
2085
2218
  # Selector specifying which fields to include in a partial response.
@@ -2110,9 +2243,9 @@ module Google
2110
2243
 
2111
2244
  # Gets a Session.
2112
2245
  # @param [String] name
2113
- # Required. The resource name of the Session to get. Format: `projects/`
2114
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2115
- # data_store_id`/sessions/`session_id``
2246
+ # Required. The resource name of the Session to get. Format: `projects/`project`/
2247
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id`/
2248
+ # sessions/`session_id``
2116
2249
  # @param [String] fields
2117
2250
  # Selector specifying which fields to include in a partial response.
2118
2251
  # @param [String] quota_user
@@ -2142,8 +2275,8 @@ module Google
2142
2275
 
2143
2276
  # Lists all Sessions by their parent DataStore.
2144
2277
  # @param [String] parent
2145
- # Required. The data store resource name. Format: `projects/`project_number`/
2146
- # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
2278
+ # Required. The data store resource name. Format: `projects/`project`/locations/`
2279
+ # location`/collections/`collection`/dataStores/`data_store_id``
2147
2280
  # @param [String] filter
2148
2281
  # A filter to apply on the list results. The supported features are:
2149
2282
  # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
@@ -2230,9 +2363,9 @@ module Google
2230
2363
 
2231
2364
  # Gets a Answer.
2232
2365
  # @param [String] name
2233
- # Required. The resource name of the Answer to get. Format: `projects/`
2234
- # project_number`/locations/`location_id`/collections/`collection`/engines/`
2235
- # engine_id`/sessions/`session_id`/answers/`answer_id``
2366
+ # Required. The resource name of the Answer to get. Format: `projects/`project`/
2367
+ # locations/`location`/collections/`collection`/engines/`engine_id`/sessions/`
2368
+ # session_id`/answers/`answer_id``
2236
2369
  # @param [String] fields
2237
2370
  # Selector specifying which fields to include in a partial response.
2238
2371
  # @param [String] quota_user
@@ -2514,6 +2647,75 @@ module Google
2514
2647
  execute_or_queue_command(command, &block)
2515
2648
  end
2516
2649
 
2650
+ # Creates a Sitemap.
2651
+ # @param [String] parent
2652
+ # Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
2653
+ # locations/*/collections/*/dataStores/*/siteSearchEngine`.
2654
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSitemap] google_cloud_discoveryengine_v1beta_sitemap_object
2655
+ # @param [String] fields
2656
+ # Selector specifying which fields to include in a partial response.
2657
+ # @param [String] quota_user
2658
+ # Available to use for quota purposes for server-side applications. Can be any
2659
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2660
+ # @param [Google::Apis::RequestOptions] options
2661
+ # Request-specific options
2662
+ #
2663
+ # @yield [result, err] Result & error if block supplied
2664
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
2665
+ # @yieldparam err [StandardError] error object if request failed
2666
+ #
2667
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
2668
+ #
2669
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2670
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2671
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2672
+ def create_project_location_collection_data_store_site_search_engine_sitemap(parent, google_cloud_discoveryengine_v1beta_sitemap_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2673
+ command = make_simple_command(:post, 'v1beta/{+parent}/sitemaps', options)
2674
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSitemap::Representation
2675
+ command.request_object = google_cloud_discoveryengine_v1beta_sitemap_object
2676
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
2677
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
2678
+ command.params['parent'] = parent unless parent.nil?
2679
+ command.query['fields'] = fields unless fields.nil?
2680
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2681
+ execute_or_queue_command(command, &block)
2682
+ end
2683
+
2684
+ # Deletes a Sitemap.
2685
+ # @param [String] name
2686
+ # Required. Full resource name of Sitemap, such as `projects/`project`/locations/
2687
+ # `location`/collections/`collection`/dataStores/`data_store`/siteSearchEngine/
2688
+ # sitemaps/`sitemap``. If the caller does not have permission to access the
2689
+ # Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is
2690
+ # returned. If the requested Sitemap does not exist, a NOT_FOUND error is
2691
+ # returned.
2692
+ # @param [String] fields
2693
+ # Selector specifying which fields to include in a partial response.
2694
+ # @param [String] quota_user
2695
+ # Available to use for quota purposes for server-side applications. Can be any
2696
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2697
+ # @param [Google::Apis::RequestOptions] options
2698
+ # Request-specific options
2699
+ #
2700
+ # @yield [result, err] Result & error if block supplied
2701
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
2702
+ # @yieldparam err [StandardError] error object if request failed
2703
+ #
2704
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
2705
+ #
2706
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2707
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2708
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2709
+ def delete_project_location_collection_data_store_site_search_engine_sitemap(name, fields: nil, quota_user: nil, options: nil, &block)
2710
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
2711
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
2712
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
2713
+ command.params['name'] = name unless name.nil?
2714
+ command.query['fields'] = fields unless fields.nil?
2715
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2716
+ execute_or_queue_command(command, &block)
2717
+ end
2718
+
2517
2719
  # Creates TargetSite in a batch.
2518
2720
  # @param [String] parent
2519
2721
  # Required. The parent resource shared by all TargetSites being created. `
@@ -2961,6 +3163,44 @@ module Google
2961
3163
  execute_or_queue_command(command, &block)
2962
3164
  end
2963
3165
 
3166
+ # Deletes permanently all user events specified by the filter provided.
3167
+ # Depending on the number of events specified by the filter, this operation
3168
+ # could take hours or days to complete. To test a filter, use the list command
3169
+ # first.
3170
+ # @param [String] parent
3171
+ # Required. The resource name of the catalog under which the events are created.
3172
+ # The format is `projects/`project`/locations/global/collections/`collection`/
3173
+ # dataStores/`dataStore``.
3174
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest] google_cloud_discoveryengine_v1beta_purge_user_events_request_object
3175
+ # @param [String] fields
3176
+ # Selector specifying which fields to include in a partial response.
3177
+ # @param [String] quota_user
3178
+ # Available to use for quota purposes for server-side applications. Can be any
3179
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3180
+ # @param [Google::Apis::RequestOptions] options
3181
+ # Request-specific options
3182
+ #
3183
+ # @yield [result, err] Result & error if block supplied
3184
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
3185
+ # @yieldparam err [StandardError] error object if request failed
3186
+ #
3187
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
3188
+ #
3189
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3190
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3191
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3192
+ def purge_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3193
+ command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:purge', options)
3194
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest::Representation
3195
+ command.request_object = google_cloud_discoveryengine_v1beta_purge_user_events_request_object
3196
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
3197
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
3198
+ command.params['parent'] = parent unless parent.nil?
3199
+ command.query['fields'] = fields unless fields.nil?
3200
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3201
+ execute_or_queue_command(command, &block)
3202
+ end
3203
+
2964
3204
  # Writes a single user event.
2965
3205
  # @param [String] parent
2966
3206
  # Required. The parent resource name. If the write user event action is applied
@@ -3153,9 +3393,9 @@ module Google
3153
3393
  # @param [String] name
3154
3394
  # Immutable. The fully qualified resource name of the engine. This field must be
3155
3395
  # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
3156
- # projects/`project_number`/locations/`location`/collections/`collection`/
3157
- # engines/`engine`` engine should be 1-63 characters, and valid characters are /
3158
- # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
3396
+ # projects/`project`/locations/`location`/collections/`collection`/engines/`
3397
+ # engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
3398
+ # Otherwise, an INVALID_ARGUMENT error is returned.
3159
3399
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine] google_cloud_discoveryengine_v1beta_engine_object
3160
3400
  # @param [String] update_mask
3161
3401
  # Indicates which fields in the provided Engine to update. If an unsupported or
@@ -3193,8 +3433,8 @@ module Google
3193
3433
  # Pauses the training of an existing engine. Only applicable if SolutionType is
3194
3434
  # SOLUTION_TYPE_RECOMMENDATION.
3195
3435
  # @param [String] name
3196
- # Required. The name of the engine to pause. Format: `projects/`project_number`/
3197
- # locations/`location_id`/collections/`collection_id`/engines/`engine_id``
3436
+ # Required. The name of the engine to pause. Format: `projects/`project`/
3437
+ # locations/`location`/collections/`collection_id`/engines/`engine_id``
3198
3438
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPauseEngineRequest] google_cloud_discoveryengine_v1beta_pause_engine_request_object
3199
3439
  # @param [String] fields
3200
3440
  # Selector specifying which fields to include in a partial response.
@@ -3228,8 +3468,8 @@ module Google
3228
3468
  # Resumes the training of an existing engine. Only applicable if SolutionType is
3229
3469
  # SOLUTION_TYPE_RECOMMENDATION.
3230
3470
  # @param [String] name
3231
- # Required. The name of the engine to resume. Format: `projects/`project_number`/
3232
- # locations/`location_id`/collections/`collection_id`/engines/`engine_id``
3471
+ # Required. The name of the engine to resume. Format: `projects/`project`/
3472
+ # locations/`location`/collections/`collection_id`/engines/`engine_id``
3233
3473
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaResumeEngineRequest] google_cloud_discoveryengine_v1beta_resume_engine_request_object
3234
3474
  # @param [String] fields
3235
3475
  # Selector specifying which fields to include in a partial response.
@@ -3263,9 +3503,8 @@ module Google
3263
3503
  # Tunes an existing engine. Only applicable if SolutionType is
3264
3504
  # SOLUTION_TYPE_RECOMMENDATION.
3265
3505
  # @param [String] name
3266
- # Required. The resource name of the engine to tune. Format: `projects/`
3267
- # project_number`/locations/`location_id`/collections/`collection_id`/engines/`
3268
- # engine_id``
3506
+ # Required. The resource name of the engine to tune. Format: `projects/`project`/
3507
+ # locations/`location`/collections/`collection_id`/engines/`engine_id``
3269
3508
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTuneEngineRequest] google_cloud_discoveryengine_v1beta_tune_engine_request_object
3270
3509
  # @param [String] fields
3271
3510
  # Selector specifying which fields to include in a partial response.
@@ -3296,14 +3535,50 @@ module Google
3296
3535
  execute_or_queue_command(command, &block)
3297
3536
  end
3298
3537
 
3538
+ # Completes the user input with advanced keyword suggestions.
3539
+ # @param [String] completion_config
3540
+ # Required. The completion_config of the parent dataStore or engine resource
3541
+ # name for which the completion is performed, such as `projects/*/locations/
3542
+ # global/collections/default_collection/dataStores/*/completionConfig` `projects/
3543
+ # */locations/global/collections/default_collection/engines/*/completionConfig`.
3544
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest] google_cloud_discoveryengine_v1beta_advanced_complete_query_request_object
3545
+ # @param [String] fields
3546
+ # Selector specifying which fields to include in a partial response.
3547
+ # @param [String] quota_user
3548
+ # Available to use for quota purposes for server-side applications. Can be any
3549
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3550
+ # @param [Google::Apis::RequestOptions] options
3551
+ # Request-specific options
3552
+ #
3553
+ # @yield [result, err] Result & error if block supplied
3554
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse] parsed result object
3555
+ # @yieldparam err [StandardError] error object if request failed
3556
+ #
3557
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse]
3558
+ #
3559
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3560
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3561
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3562
+ def complete_project_location_collection_engine_completion_config_query(completion_config, google_cloud_discoveryengine_v1beta_advanced_complete_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3563
+ command = make_simple_command(:post, 'v1beta/{+completionConfig}:completeQuery', options)
3564
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest::Representation
3565
+ command.request_object = google_cloud_discoveryengine_v1beta_advanced_complete_query_request_object
3566
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse::Representation
3567
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse
3568
+ command.params['completionConfig'] = completion_config unless completion_config.nil?
3569
+ command.query['fields'] = fields unless fields.nil?
3570
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3571
+ execute_or_queue_command(command, &block)
3572
+ end
3573
+
3299
3574
  # Creates a Control. By default 1000 controls are allowed for a data store. A
3300
3575
  # request can be submitted to adjust this limit. If the Control to create
3301
3576
  # already exists, an ALREADY_EXISTS error is returned.
3302
3577
  # @param [String] parent
3303
- # Required. Full resource name of parent data store. Format: `projects/`
3304
- # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3305
- # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
3306
- # collections/`collection_id`/engines/`engine_id``.
3578
+ # Required. Full resource name of parent data store. Format: `projects/`project`/
3579
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``
3580
+ # or `projects/`project`/locations/`location`/collections/`collection_id`/
3581
+ # engines/`engine_id``.
3307
3582
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
3308
3583
  # @param [String] control_id
3309
3584
  # Required. The ID to use for the Control, which will become the final component
@@ -3343,8 +3618,8 @@ module Google
3343
3618
  # is returned.
3344
3619
  # @param [String] name
3345
3620
  # Required. The resource name of the Control to delete. Format: `projects/`
3346
- # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3347
- # `data_store_id`/controls/`control_id``
3621
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
3622
+ # data_store_id`/controls/`control_id``
3348
3623
  # @param [String] fields
3349
3624
  # Selector specifying which fields to include in a partial response.
3350
3625
  # @param [String] quota_user
@@ -3374,9 +3649,9 @@ module Google
3374
3649
 
3375
3650
  # Gets a Control.
3376
3651
  # @param [String] name
3377
- # Required. The resource name of the Control to get. Format: `projects/`
3378
- # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3379
- # `data_store_id`/controls/`control_id``
3652
+ # Required. The resource name of the Control to get. Format: `projects/`project`/
3653
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
3654
+ # controls/`control_id``
3380
3655
  # @param [String] fields
3381
3656
  # Selector specifying which fields to include in a partial response.
3382
3657
  # @param [String] quota_user
@@ -3406,10 +3681,10 @@ module Google
3406
3681
 
3407
3682
  # Lists all Controls by their parent DataStore.
3408
3683
  # @param [String] parent
3409
- # Required. The data store resource name. Format: `projects/`project_number`/
3410
- # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
3411
- # or `projects/`project_number`/locations/`location_id`/collections/`
3412
- # collection_id`/engines/`engine_id``.
3684
+ # Required. The data store resource name. Format: `projects/`project`/locations/`
3685
+ # location`/collections/`collection_id`/dataStores/`data_store_id`` or `projects/
3686
+ # `project`/locations/`location`/collections/`collection_id`/engines/`engine_id``
3687
+ # .
3413
3688
  # @param [String] filter
3414
3689
  # Optional. A filter to apply on the list results. Supported features: * List
3415
3690
  # all the products under the parent branch if filter is unset. Currently this
@@ -3493,9 +3768,9 @@ module Google
3493
3768
  # Converses a conversation.
3494
3769
  # @param [String] name
3495
3770
  # Required. The resource name of the Conversation to get. Format: `projects/`
3496
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3497
- # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
3498
- # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
3771
+ # project`/locations/`location`/collections/`collection`/dataStores/`
3772
+ # data_store_id`/conversations/`conversation_id``. Use `projects/`project`/
3773
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id`/
3499
3774
  # conversations/-` to activate auto session mode, which automatically creates a
3500
3775
  # new conversation inside a ConverseConversation session.
3501
3776
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest] google_cloud_discoveryengine_v1beta_converse_conversation_request_object
@@ -3531,9 +3806,8 @@ module Google
3531
3806
  # Creates a Conversation. If the Conversation to create already exists, an
3532
3807
  # ALREADY_EXISTS error is returned.
3533
3808
  # @param [String] parent
3534
- # Required. Full resource name of parent data store. Format: `projects/`
3535
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3536
- # data_store_id``
3809
+ # Required. Full resource name of parent data store. Format: `projects/`project`/
3810
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id``
3537
3811
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
3538
3812
  # @param [String] fields
3539
3813
  # Selector specifying which fields to include in a partial response.
@@ -3568,7 +3842,7 @@ module Google
3568
3842
  # NOT_FOUND error is returned.
3569
3843
  # @param [String] name
3570
3844
  # Required. The resource name of the Conversation to delete. Format: `projects/`
3571
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3845
+ # project`/locations/`location`/collections/`collection`/dataStores/`
3572
3846
  # data_store_id`/conversations/`conversation_id``
3573
3847
  # @param [String] fields
3574
3848
  # Selector specifying which fields to include in a partial response.
@@ -3600,7 +3874,7 @@ module Google
3600
3874
  # Gets a Conversation.
3601
3875
  # @param [String] name
3602
3876
  # Required. The resource name of the Conversation to get. Format: `projects/`
3603
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3877
+ # project`/locations/`location`/collections/`collection`/dataStores/`
3604
3878
  # data_store_id`/conversations/`conversation_id``
3605
3879
  # @param [String] fields
3606
3880
  # Selector specifying which fields to include in a partial response.
@@ -3631,8 +3905,8 @@ module Google
3631
3905
 
3632
3906
  # Lists all Conversations by their parent DataStore.
3633
3907
  # @param [String] parent
3634
- # Required. The data store resource name. Format: `projects/`project_number`/
3635
- # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
3908
+ # Required. The data store resource name. Format: `projects/`project`/locations/`
3909
+ # location`/collections/`collection`/dataStores/`data_store_id``
3636
3910
  # @param [String] filter
3637
3911
  # A filter to apply on the list results. The supported features are:
3638
3912
  # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
@@ -3831,7 +4105,7 @@ module Google
3831
4105
  # exist.
3832
4106
  # @param [String] name
3833
4107
  # Required. The resource name of the ServingConfig to get. Format: `projects/`
3834
- # project_number`/locations/`location`/collections/`collection`/engines/`engine`/
4108
+ # project`/locations/`location`/collections/`collection`/engines/`engine`/
3835
4109
  # servingConfigs/`serving_config_id``
3836
4110
  # @param [String] fields
3837
4111
  # Selector specifying which fields to include in a partial response.
@@ -3863,7 +4137,7 @@ module Google
3863
4137
  # Lists all ServingConfigs linked to this dataStore.
3864
4138
  # @param [String] parent
3865
4139
  # Required. Full resource name of the parent resource. Format: `projects/`
3866
- # project_number`/locations/`location`/collections/`collection`/engines/`engine``
4140
+ # project`/locations/`location`/collections/`collection`/engines/`engine``
3867
4141
  # @param [Fixnum] page_size
3868
4142
  # Optional. Maximum number of results to return. If unspecified, defaults to 100.
3869
4143
  # If a value greater than 100 is provided, at most 100 results are returned.
@@ -4018,12 +4292,56 @@ module Google
4018
4292
  execute_or_queue_command(command, &block)
4019
4293
  end
4020
4294
 
4295
+ # Performs a search. Similar to the SearchService.Search method, but a lite
4296
+ # version that allows API key for authentication, where OAuth and IAM checks are
4297
+ # not required. Only public website search is supported by this method. If data
4298
+ # stores and engines not associated with public website search are specified, a `
4299
+ # FAILED_PRECONDITION` error is returned. This method can be used for easy
4300
+ # onboarding without having to implement an authentication backend. However, it
4301
+ # is strongly recommended to use SearchService.Search instead with required
4302
+ # OAuth and IAM checks to provide better data security.
4303
+ # @param [String] serving_config
4304
+ # Required. The resource name of the Search serving config, such as `projects/*/
4305
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
4306
+ # default_serving_config`, or `projects/*/locations/global/collections/
4307
+ # default_collection/dataStores/default_data_store/servingConfigs/
4308
+ # default_serving_config`. This field is used to identify the serving
4309
+ # configuration name, set of models used to make the search.
4310
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
4311
+ # @param [String] fields
4312
+ # Selector specifying which fields to include in a partial response.
4313
+ # @param [String] quota_user
4314
+ # Available to use for quota purposes for server-side applications. Can be any
4315
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4316
+ # @param [Google::Apis::RequestOptions] options
4317
+ # Request-specific options
4318
+ #
4319
+ # @yield [result, err] Result & error if block supplied
4320
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse] parsed result object
4321
+ # @yieldparam err [StandardError] error object if request failed
4322
+ #
4323
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse]
4324
+ #
4325
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4326
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4327
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4328
+ def search_project_location_collection_engine_serving_config_lite(serving_config, google_cloud_discoveryengine_v1beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4329
+ command = make_simple_command(:post, 'v1beta/{+servingConfig}:searchLite', options)
4330
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest::Representation
4331
+ command.request_object = google_cloud_discoveryengine_v1beta_search_request_object
4332
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse::Representation
4333
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
4334
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
4335
+ command.query['fields'] = fields unless fields.nil?
4336
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4337
+ execute_or_queue_command(command, &block)
4338
+ end
4339
+
4021
4340
  # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
4022
4341
  # error is returned.
4023
4342
  # @param [String] parent
4024
- # Required. Full resource name of parent data store. Format: `projects/`
4025
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
4026
- # data_store_id``
4343
+ # Required. Full resource name of parent data store. Format: `projects/`project`/
4344
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id``
4027
4345
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] google_cloud_discoveryengine_v1beta_session_object
4028
4346
  # @param [String] fields
4029
4347
  # Selector specifying which fields to include in a partial response.
@@ -4058,7 +4376,7 @@ module Google
4058
4376
  # is returned.
4059
4377
  # @param [String] name
4060
4378
  # Required. The resource name of the Session to delete. Format: `projects/`
4061
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
4379
+ # project`/locations/`location`/collections/`collection`/dataStores/`
4062
4380
  # data_store_id`/sessions/`session_id``
4063
4381
  # @param [String] fields
4064
4382
  # Selector specifying which fields to include in a partial response.
@@ -4089,9 +4407,9 @@ module Google
4089
4407
 
4090
4408
  # Gets a Session.
4091
4409
  # @param [String] name
4092
- # Required. The resource name of the Session to get. Format: `projects/`
4093
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
4094
- # data_store_id`/sessions/`session_id``
4410
+ # Required. The resource name of the Session to get. Format: `projects/`project`/
4411
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id`/
4412
+ # sessions/`session_id``
4095
4413
  # @param [String] fields
4096
4414
  # Selector specifying which fields to include in a partial response.
4097
4415
  # @param [String] quota_user
@@ -4121,8 +4439,8 @@ module Google
4121
4439
 
4122
4440
  # Lists all Sessions by their parent DataStore.
4123
4441
  # @param [String] parent
4124
- # Required. The data store resource name. Format: `projects/`project_number`/
4125
- # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
4442
+ # Required. The data store resource name. Format: `projects/`project`/locations/`
4443
+ # location`/collections/`collection`/dataStores/`data_store_id``
4126
4444
  # @param [String] filter
4127
4445
  # A filter to apply on the list results. The supported features are:
4128
4446
  # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
@@ -4209,9 +4527,9 @@ module Google
4209
4527
 
4210
4528
  # Gets a Answer.
4211
4529
  # @param [String] name
4212
- # Required. The resource name of the Answer to get. Format: `projects/`
4213
- # project_number`/locations/`location_id`/collections/`collection`/engines/`
4214
- # engine_id`/sessions/`session_id`/answers/`answer_id``
4530
+ # Required. The resource name of the Answer to get. Format: `projects/`project`/
4531
+ # locations/`location`/collections/`collection`/engines/`engine_id`/sessions/`
4532
+ # session_id`/answers/`answer_id``
4215
4533
  # @param [String] fields
4216
4534
  # Selector specifying which fields to include in a partial response.
4217
4535
  # @param [String] quota_user
@@ -4380,6 +4698,8 @@ module Google
4380
4698
  # Required. The parent resource name, such as `projects/`project`/locations/`
4381
4699
  # location`/collections/`collection``.
4382
4700
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore] google_cloud_discoveryengine_v1beta_data_store_object
4701
+ # @param [String] cmek_config_name
4702
+ # Resource name of the CmekConfig to use for protecting this DataStore.
4383
4703
  # @param [Boolean] create_advanced_site_search
4384
4704
  # A boolean flag indicating whether user want to directly create an advanced
4385
4705
  # data store for site search. If the data store is not configured as site search
@@ -4390,6 +4710,15 @@ module Google
4390
4710
  # component of the DataStore's resource name. This field must conform to [RFC-
4391
4711
  # 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
4392
4712
  # characters. Otherwise, an INVALID_ARGUMENT error is returned.
4713
+ # @param [Boolean] disable_cmek
4714
+ # DataStore without CMEK protections. If a default CmekConfig is set for the
4715
+ # project, setting this field will override the default CmekConfig as well.
4716
+ # @param [Boolean] skip_default_schema_creation
4717
+ # A boolean flag indicating whether to skip the default schema creation for the
4718
+ # data store. Only enable this flag if you are certain that the default schema
4719
+ # is incompatible with your use case. If set to true, you must manually create a
4720
+ # schema for the data store before any documents can be ingested. This flag
4721
+ # cannot be specified if `data_store.starting_schema` is specified.
4393
4722
  # @param [String] fields
4394
4723
  # Selector specifying which fields to include in a partial response.
4395
4724
  # @param [String] quota_user
@@ -4407,15 +4736,18 @@ module Google
4407
4736
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4408
4737
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4409
4738
  # @raise [Google::Apis::AuthorizationError] Authorization is required
4410
- 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)
4739
+ def create_project_location_data_store(parent, google_cloud_discoveryengine_v1beta_data_store_object = nil, cmek_config_name: nil, create_advanced_site_search: nil, data_store_id: nil, disable_cmek: nil, skip_default_schema_creation: nil, fields: nil, quota_user: nil, options: nil, &block)
4411
4740
  command = make_simple_command(:post, 'v1beta/{+parent}/dataStores', options)
4412
4741
  command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore::Representation
4413
4742
  command.request_object = google_cloud_discoveryengine_v1beta_data_store_object
4414
4743
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
4415
4744
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
4416
4745
  command.params['parent'] = parent unless parent.nil?
4746
+ command.query['cmekConfigName'] = cmek_config_name unless cmek_config_name.nil?
4417
4747
  command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
4418
4748
  command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
4749
+ command.query['disableCmek'] = disable_cmek unless disable_cmek.nil?
4750
+ command.query['skipDefaultSchemaCreation'] = skip_default_schema_creation unless skip_default_schema_creation.nil?
4419
4751
  command.query['fields'] = fields unless fields.nil?
4420
4752
  command.query['quotaUser'] = quota_user unless quota_user.nil?
4421
4753
  execute_or_queue_command(command, &block)
@@ -4612,6 +4944,46 @@ module Google
4612
4944
  execute_or_queue_command(command, &block)
4613
4945
  end
4614
4946
 
4947
+ # Gets index freshness metadata for Documents. Supported for website search only.
4948
+ # @param [String] parent
4949
+ # Required. The parent branch resource name, such as `projects/`project`/
4950
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
4951
+ # `branch``.
4952
+ # @param [Array<String>, String] matcher_fhir_matcher_fhir_resources
4953
+ # Required. The FHIR resources to match by. Format: projects/`project`/locations/
4954
+ # `location`/datasets/`dataset`/fhirStores/`fhir_store`/fhir/`resource_type`/`
4955
+ # fhir_resource_id`
4956
+ # @param [Array<String>, String] matcher_uris_matcher_uris
4957
+ # The exact URIs to match by.
4958
+ # @param [String] fields
4959
+ # Selector specifying which fields to include in a partial response.
4960
+ # @param [String] quota_user
4961
+ # Available to use for quota purposes for server-side applications. Can be any
4962
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4963
+ # @param [Google::Apis::RequestOptions] options
4964
+ # Request-specific options
4965
+ #
4966
+ # @yield [result, err] Result & error if block supplied
4967
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse] parsed result object
4968
+ # @yieldparam err [StandardError] error object if request failed
4969
+ #
4970
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse]
4971
+ #
4972
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4973
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4974
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4975
+ def batch_project_location_data_store_branch_get_documents_metadata(parent, matcher_fhir_matcher_fhir_resources: nil, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
4976
+ command = make_simple_command(:get, 'v1beta/{+parent}/batchGetDocumentsMetadata', options)
4977
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse::Representation
4978
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse
4979
+ command.params['parent'] = parent unless parent.nil?
4980
+ command.query['matcher.fhirMatcher.fhirResources'] = matcher_fhir_matcher_fhir_resources unless matcher_fhir_matcher_fhir_resources.nil?
4981
+ command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
4982
+ command.query['fields'] = fields unless fields.nil?
4983
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4984
+ execute_or_queue_command(command, &block)
4985
+ end
4986
+
4615
4987
  # Creates a Document.
4616
4988
  # @param [String] parent
4617
4989
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -4898,8 +5270,8 @@ module Google
4898
5270
  # Clients can use Operations.GetOperation or other methods to check whether the
4899
5271
  # cancellation succeeded or whether the operation completed despite cancellation.
4900
5272
  # On successful cancellation, the operation is not deleted; instead, it becomes
4901
- # an operation with an Operation.error value with a google.rpc.Status.code of 1,
4902
- # corresponding to `Code.CANCELLED`.
5273
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
5274
+ # , corresponding to `Code.CANCELLED`.
4903
5275
  # @param [String] name
4904
5276
  # The name of the operation resource to be cancelled.
4905
5277
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
@@ -5003,12 +5375,13 @@ module Google
5003
5375
  execute_or_queue_command(command, &block)
5004
5376
  end
5005
5377
 
5006
- # Imports CompletionSuggestions for a DataStore.
5007
- # @param [String] parent
5008
- # Required. The parent data store resource name for which to import customer
5009
- # autocomplete suggestions. Follows pattern `projects/*/locations/*/collections/*
5010
- # /dataStores/*`
5011
- # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest] google_cloud_discoveryengine_v1beta_import_completion_suggestions_request_object
5378
+ # Completes the user input with advanced keyword suggestions.
5379
+ # @param [String] completion_config
5380
+ # Required. The completion_config of the parent dataStore or engine resource
5381
+ # name for which the completion is performed, such as `projects/*/locations/
5382
+ # global/collections/default_collection/dataStores/*/completionConfig` `projects/
5383
+ # */locations/global/collections/default_collection/engines/*/completionConfig`.
5384
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest] google_cloud_discoveryengine_v1beta_advanced_complete_query_request_object
5012
5385
  # @param [String] fields
5013
5386
  # Selector specifying which fields to include in a partial response.
5014
5387
  # @param [String] quota_user
@@ -5018,16 +5391,51 @@ module Google
5018
5391
  # Request-specific options
5019
5392
  #
5020
5393
  # @yield [result, err] Result & error if block supplied
5021
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
5394
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse] parsed result object
5022
5395
  # @yieldparam err [StandardError] error object if request failed
5023
5396
  #
5024
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
5397
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse]
5025
5398
  #
5026
5399
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5027
5400
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5028
5401
  # @raise [Google::Apis::AuthorizationError] Authorization is required
5029
- def import_project_location_data_store_completion_suggestion(parent, google_cloud_discoveryengine_v1beta_import_completion_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5030
- command = make_simple_command(:post, 'v1beta/{+parent}/completionSuggestions:import', options)
5402
+ def complete_project_location_data_store_completion_config_query(completion_config, google_cloud_discoveryengine_v1beta_advanced_complete_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5403
+ command = make_simple_command(:post, 'v1beta/{+completionConfig}:completeQuery', options)
5404
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest::Representation
5405
+ command.request_object = google_cloud_discoveryengine_v1beta_advanced_complete_query_request_object
5406
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse::Representation
5407
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse
5408
+ command.params['completionConfig'] = completion_config unless completion_config.nil?
5409
+ command.query['fields'] = fields unless fields.nil?
5410
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5411
+ execute_or_queue_command(command, &block)
5412
+ end
5413
+
5414
+ # Imports CompletionSuggestions for a DataStore.
5415
+ # @param [String] parent
5416
+ # Required. The parent data store resource name for which to import customer
5417
+ # autocomplete suggestions. Follows pattern `projects/*/locations/*/collections/*
5418
+ # /dataStores/*`
5419
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest] google_cloud_discoveryengine_v1beta_import_completion_suggestions_request_object
5420
+ # @param [String] fields
5421
+ # Selector specifying which fields to include in a partial response.
5422
+ # @param [String] quota_user
5423
+ # Available to use for quota purposes for server-side applications. Can be any
5424
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5425
+ # @param [Google::Apis::RequestOptions] options
5426
+ # Request-specific options
5427
+ #
5428
+ # @yield [result, err] Result & error if block supplied
5429
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
5430
+ # @yieldparam err [StandardError] error object if request failed
5431
+ #
5432
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
5433
+ #
5434
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5435
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5436
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5437
+ def import_project_location_data_store_completion_suggestion(parent, google_cloud_discoveryengine_v1beta_import_completion_suggestions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5438
+ command = make_simple_command(:post, 'v1beta/{+parent}/completionSuggestions:import', options)
5031
5439
  command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest::Representation
5032
5440
  command.request_object = google_cloud_discoveryengine_v1beta_import_completion_suggestions_request_object
5033
5441
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
@@ -5076,10 +5484,10 @@ module Google
5076
5484
  # request can be submitted to adjust this limit. If the Control to create
5077
5485
  # already exists, an ALREADY_EXISTS error is returned.
5078
5486
  # @param [String] parent
5079
- # Required. Full resource name of parent data store. Format: `projects/`
5080
- # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
5081
- # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
5082
- # collections/`collection_id`/engines/`engine_id``.
5487
+ # Required. Full resource name of parent data store. Format: `projects/`project`/
5488
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``
5489
+ # or `projects/`project`/locations/`location`/collections/`collection_id`/
5490
+ # engines/`engine_id``.
5083
5491
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
5084
5492
  # @param [String] control_id
5085
5493
  # Required. The ID to use for the Control, which will become the final component
@@ -5119,8 +5527,8 @@ module Google
5119
5527
  # is returned.
5120
5528
  # @param [String] name
5121
5529
  # Required. The resource name of the Control to delete. Format: `projects/`
5122
- # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
5123
- # `data_store_id`/controls/`control_id``
5530
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
5531
+ # data_store_id`/controls/`control_id``
5124
5532
  # @param [String] fields
5125
5533
  # Selector specifying which fields to include in a partial response.
5126
5534
  # @param [String] quota_user
@@ -5150,9 +5558,9 @@ module Google
5150
5558
 
5151
5559
  # Gets a Control.
5152
5560
  # @param [String] name
5153
- # Required. The resource name of the Control to get. Format: `projects/`
5154
- # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
5155
- # `data_store_id`/controls/`control_id``
5561
+ # Required. The resource name of the Control to get. Format: `projects/`project`/
5562
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
5563
+ # controls/`control_id``
5156
5564
  # @param [String] fields
5157
5565
  # Selector specifying which fields to include in a partial response.
5158
5566
  # @param [String] quota_user
@@ -5182,10 +5590,10 @@ module Google
5182
5590
 
5183
5591
  # Lists all Controls by their parent DataStore.
5184
5592
  # @param [String] parent
5185
- # Required. The data store resource name. Format: `projects/`project_number`/
5186
- # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
5187
- # or `projects/`project_number`/locations/`location_id`/collections/`
5188
- # collection_id`/engines/`engine_id``.
5593
+ # Required. The data store resource name. Format: `projects/`project`/locations/`
5594
+ # location`/collections/`collection_id`/dataStores/`data_store_id`` or `projects/
5595
+ # `project`/locations/`location`/collections/`collection_id`/engines/`engine_id``
5596
+ # .
5189
5597
  # @param [String] filter
5190
5598
  # Optional. A filter to apply on the list results. Supported features: * List
5191
5599
  # all the products under the parent branch if filter is unset. Currently this
@@ -5269,9 +5677,9 @@ module Google
5269
5677
  # Converses a conversation.
5270
5678
  # @param [String] name
5271
5679
  # Required. The resource name of the Conversation to get. Format: `projects/`
5272
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5273
- # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
5274
- # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
5680
+ # project`/locations/`location`/collections/`collection`/dataStores/`
5681
+ # data_store_id`/conversations/`conversation_id``. Use `projects/`project`/
5682
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id`/
5275
5683
  # conversations/-` to activate auto session mode, which automatically creates a
5276
5684
  # new conversation inside a ConverseConversation session.
5277
5685
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest] google_cloud_discoveryengine_v1beta_converse_conversation_request_object
@@ -5307,9 +5715,8 @@ module Google
5307
5715
  # Creates a Conversation. If the Conversation to create already exists, an
5308
5716
  # ALREADY_EXISTS error is returned.
5309
5717
  # @param [String] parent
5310
- # Required. Full resource name of parent data store. Format: `projects/`
5311
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5312
- # data_store_id``
5718
+ # Required. Full resource name of parent data store. Format: `projects/`project`/
5719
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id``
5313
5720
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
5314
5721
  # @param [String] fields
5315
5722
  # Selector specifying which fields to include in a partial response.
@@ -5344,7 +5751,7 @@ module Google
5344
5751
  # NOT_FOUND error is returned.
5345
5752
  # @param [String] name
5346
5753
  # Required. The resource name of the Conversation to delete. Format: `projects/`
5347
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5754
+ # project`/locations/`location`/collections/`collection`/dataStores/`
5348
5755
  # data_store_id`/conversations/`conversation_id``
5349
5756
  # @param [String] fields
5350
5757
  # Selector specifying which fields to include in a partial response.
@@ -5376,7 +5783,7 @@ module Google
5376
5783
  # Gets a Conversation.
5377
5784
  # @param [String] name
5378
5785
  # Required. The resource name of the Conversation to get. Format: `projects/`
5379
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
5786
+ # project`/locations/`location`/collections/`collection`/dataStores/`
5380
5787
  # data_store_id`/conversations/`conversation_id``
5381
5788
  # @param [String] fields
5382
5789
  # Selector specifying which fields to include in a partial response.
@@ -5407,8 +5814,8 @@ module Google
5407
5814
 
5408
5815
  # Lists all Conversations by their parent DataStore.
5409
5816
  # @param [String] parent
5410
- # Required. The data store resource name. Format: `projects/`project_number`/
5411
- # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
5817
+ # Required. The data store resource name. Format: `projects/`project`/locations/`
5818
+ # location`/collections/`collection`/dataStores/`data_store_id``
5412
5819
  # @param [String] filter
5413
5820
  # A filter to apply on the list results. The supported features are:
5414
5821
  # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
@@ -5865,7 +6272,7 @@ module Google
5865
6272
  # exist.
5866
6273
  # @param [String] name
5867
6274
  # Required. The resource name of the ServingConfig to get. Format: `projects/`
5868
- # project_number`/locations/`location`/collections/`collection`/engines/`engine`/
6275
+ # project`/locations/`location`/collections/`collection`/engines/`engine`/
5869
6276
  # servingConfigs/`serving_config_id``
5870
6277
  # @param [String] fields
5871
6278
  # Selector specifying which fields to include in a partial response.
@@ -5897,7 +6304,7 @@ module Google
5897
6304
  # Lists all ServingConfigs linked to this dataStore.
5898
6305
  # @param [String] parent
5899
6306
  # Required. Full resource name of the parent resource. Format: `projects/`
5900
- # project_number`/locations/`location`/collections/`collection`/engines/`engine``
6307
+ # project`/locations/`location`/collections/`collection`/engines/`engine``
5901
6308
  # @param [Fixnum] page_size
5902
6309
  # Optional. Maximum number of results to return. If unspecified, defaults to 100.
5903
6310
  # If a value greater than 100 is provided, at most 100 results are returned.
@@ -6052,12 +6459,56 @@ module Google
6052
6459
  execute_or_queue_command(command, &block)
6053
6460
  end
6054
6461
 
6462
+ # Performs a search. Similar to the SearchService.Search method, but a lite
6463
+ # version that allows API key for authentication, where OAuth and IAM checks are
6464
+ # not required. Only public website search is supported by this method. If data
6465
+ # stores and engines not associated with public website search are specified, a `
6466
+ # FAILED_PRECONDITION` error is returned. This method can be used for easy
6467
+ # onboarding without having to implement an authentication backend. However, it
6468
+ # is strongly recommended to use SearchService.Search instead with required
6469
+ # OAuth and IAM checks to provide better data security.
6470
+ # @param [String] serving_config
6471
+ # Required. The resource name of the Search serving config, such as `projects/*/
6472
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
6473
+ # default_serving_config`, or `projects/*/locations/global/collections/
6474
+ # default_collection/dataStores/default_data_store/servingConfigs/
6475
+ # default_serving_config`. This field is used to identify the serving
6476
+ # configuration name, set of models used to make the search.
6477
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
6478
+ # @param [String] fields
6479
+ # Selector specifying which fields to include in a partial response.
6480
+ # @param [String] quota_user
6481
+ # Available to use for quota purposes for server-side applications. Can be any
6482
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6483
+ # @param [Google::Apis::RequestOptions] options
6484
+ # Request-specific options
6485
+ #
6486
+ # @yield [result, err] Result & error if block supplied
6487
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse] parsed result object
6488
+ # @yieldparam err [StandardError] error object if request failed
6489
+ #
6490
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse]
6491
+ #
6492
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6493
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6494
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6495
+ def search_project_location_data_store_serving_config_lite(serving_config, google_cloud_discoveryengine_v1beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6496
+ command = make_simple_command(:post, 'v1beta/{+servingConfig}:searchLite', options)
6497
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest::Representation
6498
+ command.request_object = google_cloud_discoveryengine_v1beta_search_request_object
6499
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse::Representation
6500
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
6501
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
6502
+ command.query['fields'] = fields unless fields.nil?
6503
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6504
+ execute_or_queue_command(command, &block)
6505
+ end
6506
+
6055
6507
  # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
6056
6508
  # error is returned.
6057
6509
  # @param [String] parent
6058
- # Required. Full resource name of parent data store. Format: `projects/`
6059
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
6060
- # data_store_id``
6510
+ # Required. Full resource name of parent data store. Format: `projects/`project`/
6511
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id``
6061
6512
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] google_cloud_discoveryengine_v1beta_session_object
6062
6513
  # @param [String] fields
6063
6514
  # Selector specifying which fields to include in a partial response.
@@ -6092,7 +6543,7 @@ module Google
6092
6543
  # is returned.
6093
6544
  # @param [String] name
6094
6545
  # Required. The resource name of the Session to delete. Format: `projects/`
6095
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
6546
+ # project`/locations/`location`/collections/`collection`/dataStores/`
6096
6547
  # data_store_id`/sessions/`session_id``
6097
6548
  # @param [String] fields
6098
6549
  # Selector specifying which fields to include in a partial response.
@@ -6123,9 +6574,9 @@ module Google
6123
6574
 
6124
6575
  # Gets a Session.
6125
6576
  # @param [String] name
6126
- # Required. The resource name of the Session to get. Format: `projects/`
6127
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
6128
- # data_store_id`/sessions/`session_id``
6577
+ # Required. The resource name of the Session to get. Format: `projects/`project`/
6578
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id`/
6579
+ # sessions/`session_id``
6129
6580
  # @param [String] fields
6130
6581
  # Selector specifying which fields to include in a partial response.
6131
6582
  # @param [String] quota_user
@@ -6155,8 +6606,8 @@ module Google
6155
6606
 
6156
6607
  # Lists all Sessions by their parent DataStore.
6157
6608
  # @param [String] parent
6158
- # Required. The data store resource name. Format: `projects/`project_number`/
6159
- # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
6609
+ # Required. The data store resource name. Format: `projects/`project`/locations/`
6610
+ # location`/collections/`collection`/dataStores/`data_store_id``
6160
6611
  # @param [String] filter
6161
6612
  # A filter to apply on the list results. The supported features are:
6162
6613
  # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
@@ -6243,9 +6694,9 @@ module Google
6243
6694
 
6244
6695
  # Gets a Answer.
6245
6696
  # @param [String] name
6246
- # Required. The resource name of the Answer to get. Format: `projects/`
6247
- # project_number`/locations/`location_id`/collections/`collection`/engines/`
6248
- # engine_id`/sessions/`session_id`/answers/`answer_id``
6697
+ # Required. The resource name of the Answer to get. Format: `projects/`project`/
6698
+ # locations/`location`/collections/`collection`/engines/`engine_id`/sessions/`
6699
+ # session_id`/answers/`answer_id``
6249
6700
  # @param [String] fields
6250
6701
  # Selector specifying which fields to include in a partial response.
6251
6702
  # @param [String] quota_user
@@ -6375,6 +6826,109 @@ module Google
6375
6826
  execute_or_queue_command(command, &block)
6376
6827
  end
6377
6828
 
6829
+ # Creates a Sitemap.
6830
+ # @param [String] parent
6831
+ # Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
6832
+ # locations/*/collections/*/dataStores/*/siteSearchEngine`.
6833
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSitemap] google_cloud_discoveryengine_v1beta_sitemap_object
6834
+ # @param [String] fields
6835
+ # Selector specifying which fields to include in a partial response.
6836
+ # @param [String] quota_user
6837
+ # Available to use for quota purposes for server-side applications. Can be any
6838
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6839
+ # @param [Google::Apis::RequestOptions] options
6840
+ # Request-specific options
6841
+ #
6842
+ # @yield [result, err] Result & error if block supplied
6843
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
6844
+ # @yieldparam err [StandardError] error object if request failed
6845
+ #
6846
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
6847
+ #
6848
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6849
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6850
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6851
+ def create_project_location_data_store_site_search_engine_sitemap(parent, google_cloud_discoveryengine_v1beta_sitemap_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6852
+ command = make_simple_command(:post, 'v1beta/{+parent}/sitemaps', options)
6853
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSitemap::Representation
6854
+ command.request_object = google_cloud_discoveryengine_v1beta_sitemap_object
6855
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
6856
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
6857
+ command.params['parent'] = parent unless parent.nil?
6858
+ command.query['fields'] = fields unless fields.nil?
6859
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6860
+ execute_or_queue_command(command, &block)
6861
+ end
6862
+
6863
+ # Deletes a Sitemap.
6864
+ # @param [String] name
6865
+ # Required. Full resource name of Sitemap, such as `projects/`project`/locations/
6866
+ # `location`/collections/`collection`/dataStores/`data_store`/siteSearchEngine/
6867
+ # sitemaps/`sitemap``. If the caller does not have permission to access the
6868
+ # Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is
6869
+ # returned. If the requested Sitemap does not exist, a NOT_FOUND error is
6870
+ # returned.
6871
+ # @param [String] fields
6872
+ # Selector specifying which fields to include in a partial response.
6873
+ # @param [String] quota_user
6874
+ # Available to use for quota purposes for server-side applications. Can be any
6875
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6876
+ # @param [Google::Apis::RequestOptions] options
6877
+ # Request-specific options
6878
+ #
6879
+ # @yield [result, err] Result & error if block supplied
6880
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
6881
+ # @yieldparam err [StandardError] error object if request failed
6882
+ #
6883
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
6884
+ #
6885
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6886
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6887
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6888
+ def delete_project_location_data_store_site_search_engine_sitemap(name, fields: nil, quota_user: nil, options: nil, &block)
6889
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
6890
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
6891
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
6892
+ command.params['name'] = name unless name.nil?
6893
+ command.query['fields'] = fields unless fields.nil?
6894
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6895
+ execute_or_queue_command(command, &block)
6896
+ end
6897
+
6898
+ # Fetch Sitemaps in a DataStore.
6899
+ # @param [String] parent
6900
+ # Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
6901
+ # locations/*/collections/*/dataStores/*/siteSearchEngine`.
6902
+ # @param [Array<String>, String] matcher_uris_matcher_uris
6903
+ # The Sitemap uris.
6904
+ # @param [String] fields
6905
+ # Selector specifying which fields to include in a partial response.
6906
+ # @param [String] quota_user
6907
+ # Available to use for quota purposes for server-side applications. Can be any
6908
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6909
+ # @param [Google::Apis::RequestOptions] options
6910
+ # Request-specific options
6911
+ #
6912
+ # @yield [result, err] Result & error if block supplied
6913
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse] parsed result object
6914
+ # @yieldparam err [StandardError] error object if request failed
6915
+ #
6916
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse]
6917
+ #
6918
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6919
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6920
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6921
+ def fetch_project_location_data_store_site_search_engine_sitemap(parent, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
6922
+ command = make_simple_command(:get, 'v1beta/{+parent}/sitemaps:fetch', options)
6923
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse::Representation
6924
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse
6925
+ command.params['parent'] = parent unless parent.nil?
6926
+ command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
6927
+ command.query['fields'] = fields unless fields.nil?
6928
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6929
+ execute_or_queue_command(command, &block)
6930
+ end
6931
+
6378
6932
  # Creates TargetSite in a batch.
6379
6933
  # @param [String] parent
6380
6934
  # Required. The parent resource shared by all TargetSites being created. `
@@ -6751,6 +7305,44 @@ module Google
6751
7305
  execute_or_queue_command(command, &block)
6752
7306
  end
6753
7307
 
7308
+ # Deletes permanently all user events specified by the filter provided.
7309
+ # Depending on the number of events specified by the filter, this operation
7310
+ # could take hours or days to complete. To test a filter, use the list command
7311
+ # first.
7312
+ # @param [String] parent
7313
+ # Required. The resource name of the catalog under which the events are created.
7314
+ # The format is `projects/`project`/locations/global/collections/`collection`/
7315
+ # dataStores/`dataStore``.
7316
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest] google_cloud_discoveryengine_v1beta_purge_user_events_request_object
7317
+ # @param [String] fields
7318
+ # Selector specifying which fields to include in a partial response.
7319
+ # @param [String] quota_user
7320
+ # Available to use for quota purposes for server-side applications. Can be any
7321
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7322
+ # @param [Google::Apis::RequestOptions] options
7323
+ # Request-specific options
7324
+ #
7325
+ # @yield [result, err] Result & error if block supplied
7326
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
7327
+ # @yieldparam err [StandardError] error object if request failed
7328
+ #
7329
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
7330
+ #
7331
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7332
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7333
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7334
+ def purge_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7335
+ command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:purge', options)
7336
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest::Representation
7337
+ command.request_object = google_cloud_discoveryengine_v1beta_purge_user_events_request_object
7338
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
7339
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
7340
+ command.params['parent'] = parent unless parent.nil?
7341
+ command.query['fields'] = fields unless fields.nil?
7342
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7343
+ execute_or_queue_command(command, &block)
7344
+ end
7345
+
6754
7346
  # Writes a single user event.
6755
7347
  # @param [String] parent
6756
7348
  # Required. The parent resource name. If the write user event action is applied
@@ -6793,11 +7385,12 @@ module Google
6793
7385
  execute_or_queue_command(command, &block)
6794
7386
  end
6795
7387
 
6796
- # Performs a grounding check.
6797
- # @param [String] grounding_config
6798
- # Required. The resource name of the grounding config, such as `projects/*/
6799
- # locations/global/groundingConfigs/default_grounding_config`.
6800
- # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingRequest] google_cloud_discoveryengine_v1beta_check_grounding_request_object
7388
+ # Creates a Evaluation. Upon creation, the evaluation will be automatically
7389
+ # triggered and begin execution.
7390
+ # @param [String] parent
7391
+ # Required. The parent resource name, such as `projects/`project`/locations/`
7392
+ # location``.
7393
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation] google_cloud_discoveryengine_v1beta_evaluation_object
6801
7394
  # @param [String] fields
6802
7395
  # Selector specifying which fields to include in a partial response.
6803
7396
  # @param [String] quota_user
@@ -6807,30 +7400,33 @@ module Google
6807
7400
  # Request-specific options
6808
7401
  #
6809
7402
  # @yield [result, err] Result & error if block supplied
6810
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse] parsed result object
7403
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
6811
7404
  # @yieldparam err [StandardError] error object if request failed
6812
7405
  #
6813
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse]
7406
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
6814
7407
  #
6815
7408
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6816
7409
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6817
7410
  # @raise [Google::Apis::AuthorizationError] Authorization is required
6818
- def check_project_location_grounding_config(grounding_config, google_cloud_discoveryengine_v1beta_check_grounding_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6819
- command = make_simple_command(:post, 'v1beta/{+groundingConfig}:check', options)
6820
- command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingRequest::Representation
6821
- command.request_object = google_cloud_discoveryengine_v1beta_check_grounding_request_object
6822
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse::Representation
6823
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse
6824
- command.params['groundingConfig'] = grounding_config unless grounding_config.nil?
7411
+ def create_project_location_evaluation(parent, google_cloud_discoveryengine_v1beta_evaluation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7412
+ command = make_simple_command(:post, 'v1beta/{+parent}/evaluations', options)
7413
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation::Representation
7414
+ command.request_object = google_cloud_discoveryengine_v1beta_evaluation_object
7415
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
7416
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
7417
+ command.params['parent'] = parent unless parent.nil?
6825
7418
  command.query['fields'] = fields unless fields.nil?
6826
7419
  command.query['quotaUser'] = quota_user unless quota_user.nil?
6827
7420
  execute_or_queue_command(command, &block)
6828
7421
  end
6829
7422
 
6830
- # Gets the latest state of a long-running operation. Clients can use this method
6831
- # to poll the operation result at intervals as recommended by the API service.
7423
+ # Gets a Evaluation.
6832
7424
  # @param [String] name
6833
- # The name of the operation resource.
7425
+ # Required. Full resource name of Evaluation, such as `projects/`project`/
7426
+ # locations/`location`/evaluations/`evaluation``. If the caller does not have
7427
+ # permission to access the Evaluation, regardless of whether or not it exists, a
7428
+ # PERMISSION_DENIED error is returned. If the requested Evaluation does not
7429
+ # exist, a NOT_FOUND error is returned.
6834
7430
  # @param [String] fields
6835
7431
  # Selector specifying which fields to include in a partial response.
6836
7432
  # @param [String] quota_user
@@ -6840,34 +7436,40 @@ module Google
6840
7436
  # Request-specific options
6841
7437
  #
6842
7438
  # @yield [result, err] Result & error if block supplied
6843
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
7439
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation] parsed result object
6844
7440
  # @yieldparam err [StandardError] error object if request failed
6845
7441
  #
6846
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
7442
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation]
6847
7443
  #
6848
7444
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6849
7445
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6850
7446
  # @raise [Google::Apis::AuthorizationError] Authorization is required
6851
- def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
7447
+ def get_project_location_evaluation(name, fields: nil, quota_user: nil, options: nil, &block)
6852
7448
  command = make_simple_command(:get, 'v1beta/{+name}', options)
6853
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
6854
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
7449
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation::Representation
7450
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation
6855
7451
  command.params['name'] = name unless name.nil?
6856
7452
  command.query['fields'] = fields unless fields.nil?
6857
7453
  command.query['quotaUser'] = quota_user unless quota_user.nil?
6858
7454
  execute_or_queue_command(command, &block)
6859
7455
  end
6860
7456
 
6861
- # Lists operations that match the specified filter in the request. If the server
6862
- # doesn't support this method, it returns `UNIMPLEMENTED`.
6863
- # @param [String] name
6864
- # The name of the operation's parent resource.
6865
- # @param [String] filter
6866
- # The standard list filter.
7457
+ # Gets a list of Evaluations.
7458
+ # @param [String] parent
7459
+ # Required. The parent location resource name, such as `projects/`project`/
7460
+ # locations/`location``. If the caller does not have permission to list
7461
+ # Evaluations under this location, regardless of whether or not this location
7462
+ # exists, a `PERMISSION_DENIED` error is returned.
6867
7463
  # @param [Fixnum] page_size
6868
- # The standard list page size.
7464
+ # Maximum number of Evaluations to return. If unspecified, defaults to 100. The
7465
+ # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
7466
+ # this field is negative, an `INVALID_ARGUMENT` error is returned.
6869
7467
  # @param [String] page_token
6870
- # The standard list page token.
7468
+ # A page token ListEvaluationsResponse.next_page_token, received from a previous
7469
+ # EvaluationService.ListEvaluations call. Provide this to retrieve the
7470
+ # subsequent page. When paginating, all other parameters provided to
7471
+ # EvaluationService.ListEvaluations must match the call that provided the page
7472
+ # token. Otherwise, an `INVALID_ARGUMENT` error is returned.
6871
7473
  # @param [String] fields
6872
7474
  # Selector specifying which fields to include in a partial response.
6873
7475
  # @param [String] quota_user
@@ -6877,20 +7479,19 @@ module Google
6877
7479
  # Request-specific options
6878
7480
  #
6879
7481
  # @yield [result, err] Result & error if block supplied
6880
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
7482
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationsResponse] parsed result object
6881
7483
  # @yieldparam err [StandardError] error object if request failed
6882
7484
  #
6883
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
7485
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationsResponse]
6884
7486
  #
6885
7487
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6886
7488
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6887
7489
  # @raise [Google::Apis::AuthorizationError] Authorization is required
6888
- def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
6889
- command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
6890
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
6891
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
6892
- command.params['name'] = name unless name.nil?
6893
- command.query['filter'] = filter unless filter.nil?
7490
+ def list_project_location_evaluations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7491
+ command = make_simple_command(:get, 'v1beta/{+parent}/evaluations', options)
7492
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationsResponse::Representation
7493
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationsResponse
7494
+ command.params['parent'] = parent unless parent.nil?
6894
7495
  command.query['pageSize'] = page_size unless page_size.nil?
6895
7496
  command.query['pageToken'] = page_token unless page_token.nil?
6896
7497
  command.query['fields'] = fields unless fields.nil?
@@ -6898,11 +7499,22 @@ module Google
6898
7499
  execute_or_queue_command(command, &block)
6899
7500
  end
6900
7501
 
6901
- # Ranks a list of text records based on the given input query.
6902
- # @param [String] ranking_config
6903
- # Required. The resource name of the rank service config, such as `projects/`
6904
- # project_num`/locations/`location_id`/rankingConfigs/default_ranking_config`.
6905
- # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankRequest] google_cloud_discoveryengine_v1beta_rank_request_object
7502
+ # Gets a list of results for a given a Evaluation.
7503
+ # @param [String] evaluation
7504
+ # Required. The evaluation resource name, such as `projects/`project`/locations/`
7505
+ # location`/evaluations/`evaluation``. If the caller does not have permission to
7506
+ # list EvaluationResult under this evaluation, regardless of whether or not this
7507
+ # evaluation set exists, a `PERMISSION_DENIED` error is returned.
7508
+ # @param [Fixnum] page_size
7509
+ # Maximum number of EvaluationResult to return. If unspecified, defaults to 100.
7510
+ # The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
7511
+ # If this field is negative, an `INVALID_ARGUMENT` error is returned.
7512
+ # @param [String] page_token
7513
+ # A page token ListEvaluationResultsResponse.next_page_token, received from a
7514
+ # previous EvaluationService.ListEvaluationResults call. Provide this to
7515
+ # retrieve the subsequent page. When paginating, all other parameters provided
7516
+ # to EvaluationService.ListEvaluationResults must match the call that provided
7517
+ # the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
6906
7518
  # @param [String] fields
6907
7519
  # Selector specifying which fields to include in a partial response.
6908
7520
  # @param [String] quota_user
@@ -6912,43 +7524,751 @@ module Google
6912
7524
  # Request-specific options
6913
7525
  #
6914
7526
  # @yield [result, err] Result & error if block supplied
6915
- # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankResponse] parsed result object
7527
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse] parsed result object
6916
7528
  # @yieldparam err [StandardError] error object if request failed
6917
7529
  #
6918
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankResponse]
7530
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse]
6919
7531
  #
6920
7532
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6921
7533
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6922
7534
  # @raise [Google::Apis::AuthorizationError] Authorization is required
6923
- def rank_project_location_ranking_config(ranking_config, google_cloud_discoveryengine_v1beta_rank_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6924
- command = make_simple_command(:post, 'v1beta/{+rankingConfig}:rank', options)
6925
- command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankRequest::Representation
6926
- command.request_object = google_cloud_discoveryengine_v1beta_rank_request_object
6927
- command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankResponse::Representation
6928
- command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankResponse
6929
- command.params['rankingConfig'] = ranking_config unless ranking_config.nil?
7535
+ def list_project_location_evaluation_results(evaluation, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7536
+ command = make_simple_command(:get, 'v1beta/{+evaluation}:listResults', options)
7537
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse::Representation
7538
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse
7539
+ command.params['evaluation'] = evaluation unless evaluation.nil?
7540
+ command.query['pageSize'] = page_size unless page_size.nil?
7541
+ command.query['pageToken'] = page_token unless page_token.nil?
6930
7542
  command.query['fields'] = fields unless fields.nil?
6931
7543
  command.query['quotaUser'] = quota_user unless quota_user.nil?
6932
7544
  execute_or_queue_command(command, &block)
6933
7545
  end
6934
7546
 
6935
- # Writes a single user event from the browser. This uses a GET request to due to
6936
- # browser restriction of POST-ing to a third-party domain. This method is used
6937
- # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
6938
- # Users should not call this method directly.
6939
- # @param [String] parent
6940
- # Required. The parent DataStore resource name, such as `projects/`project`/
6941
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
6942
- # @param [Fixnum] ets
6943
- # The event timestamp in milliseconds. This prevents browser caching of
6944
- # otherwise identical get requests. The name is abbreviated to reduce the
6945
- # payload bytes.
6946
- # @param [String] uri
6947
- # The URL including cgi-parameters but excluding the hash fragment with a length
6948
- # limit of 5,000 characters. This is often more useful than the referer URL,
6949
- # because many browsers only send the domain for third-party requests.
6950
- # @param [String] user_event
6951
- # Required. URL encoded UserEvent proto with a length limit of 2,000,000
7547
+ # Gets the latest state of a long-running operation. Clients can use this method
7548
+ # to poll the operation result at intervals as recommended by the API service.
7549
+ # @param [String] name
7550
+ # The name of the operation resource.
7551
+ # @param [String] fields
7552
+ # Selector specifying which fields to include in a partial response.
7553
+ # @param [String] quota_user
7554
+ # Available to use for quota purposes for server-side applications. Can be any
7555
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7556
+ # @param [Google::Apis::RequestOptions] options
7557
+ # Request-specific options
7558
+ #
7559
+ # @yield [result, err] Result & error if block supplied
7560
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
7561
+ # @yieldparam err [StandardError] error object if request failed
7562
+ #
7563
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
7564
+ #
7565
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7566
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7567
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7568
+ def get_project_location_evaluation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
7569
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
7570
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
7571
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
7572
+ command.params['name'] = name unless name.nil?
7573
+ command.query['fields'] = fields unless fields.nil?
7574
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7575
+ execute_or_queue_command(command, &block)
7576
+ end
7577
+
7578
+ # Performs a grounding check.
7579
+ # @param [String] grounding_config
7580
+ # Required. The resource name of the grounding config, such as `projects/*/
7581
+ # locations/global/groundingConfigs/default_grounding_config`.
7582
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingRequest] google_cloud_discoveryengine_v1beta_check_grounding_request_object
7583
+ # @param [String] fields
7584
+ # Selector specifying which fields to include in a partial response.
7585
+ # @param [String] quota_user
7586
+ # Available to use for quota purposes for server-side applications. Can be any
7587
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7588
+ # @param [Google::Apis::RequestOptions] options
7589
+ # Request-specific options
7590
+ #
7591
+ # @yield [result, err] Result & error if block supplied
7592
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse] parsed result object
7593
+ # @yieldparam err [StandardError] error object if request failed
7594
+ #
7595
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse]
7596
+ #
7597
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7598
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7599
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7600
+ def check_project_location_grounding_config(grounding_config, google_cloud_discoveryengine_v1beta_check_grounding_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7601
+ command = make_simple_command(:post, 'v1beta/{+groundingConfig}:check', options)
7602
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingRequest::Representation
7603
+ command.request_object = google_cloud_discoveryengine_v1beta_check_grounding_request_object
7604
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse::Representation
7605
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse
7606
+ command.params['groundingConfig'] = grounding_config unless grounding_config.nil?
7607
+ command.query['fields'] = fields unless fields.nil?
7608
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7609
+ execute_or_queue_command(command, &block)
7610
+ end
7611
+
7612
+ # Gets the latest state of a long-running operation. Clients can use this method
7613
+ # to poll the operation result at intervals as recommended by the API service.
7614
+ # @param [String] name
7615
+ # The name of the operation resource.
7616
+ # @param [String] fields
7617
+ # Selector specifying which fields to include in a partial response.
7618
+ # @param [String] quota_user
7619
+ # Available to use for quota purposes for server-side applications. Can be any
7620
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7621
+ # @param [Google::Apis::RequestOptions] options
7622
+ # Request-specific options
7623
+ #
7624
+ # @yield [result, err] Result & error if block supplied
7625
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
7626
+ # @yieldparam err [StandardError] error object if request failed
7627
+ #
7628
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
7629
+ #
7630
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7631
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7632
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7633
+ def get_project_location_identity_mapping_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
7634
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
7635
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
7636
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
7637
+ command.params['name'] = name unless name.nil?
7638
+ command.query['fields'] = fields unless fields.nil?
7639
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7640
+ execute_or_queue_command(command, &block)
7641
+ end
7642
+
7643
+ # Lists operations that match the specified filter in the request. If the server
7644
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
7645
+ # @param [String] name
7646
+ # The name of the operation's parent resource.
7647
+ # @param [String] filter
7648
+ # The standard list filter.
7649
+ # @param [Fixnum] page_size
7650
+ # The standard list page size.
7651
+ # @param [String] page_token
7652
+ # The standard list page token.
7653
+ # @param [String] fields
7654
+ # Selector specifying which fields to include in a partial response.
7655
+ # @param [String] quota_user
7656
+ # Available to use for quota purposes for server-side applications. Can be any
7657
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7658
+ # @param [Google::Apis::RequestOptions] options
7659
+ # Request-specific options
7660
+ #
7661
+ # @yield [result, err] Result & error if block supplied
7662
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
7663
+ # @yieldparam err [StandardError] error object if request failed
7664
+ #
7665
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
7666
+ #
7667
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7668
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7669
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7670
+ def list_project_location_identity_mapping_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7671
+ command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
7672
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
7673
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
7674
+ command.params['name'] = name unless name.nil?
7675
+ command.query['filter'] = filter unless filter.nil?
7676
+ command.query['pageSize'] = page_size unless page_size.nil?
7677
+ command.query['pageToken'] = page_token unless page_token.nil?
7678
+ command.query['fields'] = fields unless fields.nil?
7679
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7680
+ execute_or_queue_command(command, &block)
7681
+ end
7682
+
7683
+ # Gets the latest state of a long-running operation. Clients can use this method
7684
+ # to poll the operation result at intervals as recommended by the API service.
7685
+ # @param [String] name
7686
+ # The name of the operation resource.
7687
+ # @param [String] fields
7688
+ # Selector specifying which fields to include in a partial response.
7689
+ # @param [String] quota_user
7690
+ # Available to use for quota purposes for server-side applications. Can be any
7691
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7692
+ # @param [Google::Apis::RequestOptions] options
7693
+ # Request-specific options
7694
+ #
7695
+ # @yield [result, err] Result & error if block supplied
7696
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
7697
+ # @yieldparam err [StandardError] error object if request failed
7698
+ #
7699
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
7700
+ #
7701
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7702
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7703
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7704
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
7705
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
7706
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
7707
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
7708
+ command.params['name'] = name unless name.nil?
7709
+ command.query['fields'] = fields unless fields.nil?
7710
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7711
+ execute_or_queue_command(command, &block)
7712
+ end
7713
+
7714
+ # Lists operations that match the specified filter in the request. If the server
7715
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
7716
+ # @param [String] name
7717
+ # The name of the operation's parent resource.
7718
+ # @param [String] filter
7719
+ # The standard list filter.
7720
+ # @param [Fixnum] page_size
7721
+ # The standard list page size.
7722
+ # @param [String] page_token
7723
+ # The standard list page token.
7724
+ # @param [String] fields
7725
+ # Selector specifying which fields to include in a partial response.
7726
+ # @param [String] quota_user
7727
+ # Available to use for quota purposes for server-side applications. Can be any
7728
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7729
+ # @param [Google::Apis::RequestOptions] options
7730
+ # Request-specific options
7731
+ #
7732
+ # @yield [result, err] Result & error if block supplied
7733
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
7734
+ # @yieldparam err [StandardError] error object if request failed
7735
+ #
7736
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
7737
+ #
7738
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7739
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7740
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7741
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7742
+ command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
7743
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
7744
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
7745
+ command.params['name'] = name unless name.nil?
7746
+ command.query['filter'] = filter unless filter.nil?
7747
+ command.query['pageSize'] = page_size unless page_size.nil?
7748
+ command.query['pageToken'] = page_token unless page_token.nil?
7749
+ command.query['fields'] = fields unless fields.nil?
7750
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7751
+ execute_or_queue_command(command, &block)
7752
+ end
7753
+
7754
+ # Ranks a list of text records based on the given input query.
7755
+ # @param [String] ranking_config
7756
+ # Required. The resource name of the rank service config, such as `projects/`
7757
+ # project_num`/locations/`location`/rankingConfigs/default_ranking_config`.
7758
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankRequest] google_cloud_discoveryengine_v1beta_rank_request_object
7759
+ # @param [String] fields
7760
+ # Selector specifying which fields to include in a partial response.
7761
+ # @param [String] quota_user
7762
+ # Available to use for quota purposes for server-side applications. Can be any
7763
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7764
+ # @param [Google::Apis::RequestOptions] options
7765
+ # Request-specific options
7766
+ #
7767
+ # @yield [result, err] Result & error if block supplied
7768
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankResponse] parsed result object
7769
+ # @yieldparam err [StandardError] error object if request failed
7770
+ #
7771
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankResponse]
7772
+ #
7773
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7774
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7775
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7776
+ def rank_project_location_ranking_config(ranking_config, google_cloud_discoveryengine_v1beta_rank_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7777
+ command = make_simple_command(:post, 'v1beta/{+rankingConfig}:rank', options)
7778
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankRequest::Representation
7779
+ command.request_object = google_cloud_discoveryengine_v1beta_rank_request_object
7780
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankResponse::Representation
7781
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankResponse
7782
+ command.params['rankingConfig'] = ranking_config unless ranking_config.nil?
7783
+ command.query['fields'] = fields unless fields.nil?
7784
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7785
+ execute_or_queue_command(command, &block)
7786
+ end
7787
+
7788
+ # Creates a SampleQuerySet
7789
+ # @param [String] parent
7790
+ # Required. The parent resource name, such as `projects/`project`/locations/`
7791
+ # location``.
7792
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet] google_cloud_discoveryengine_v1beta_sample_query_set_object
7793
+ # @param [String] sample_query_set_id
7794
+ # Required. The ID to use for the SampleQuerySet, which will become the final
7795
+ # component of the SampleQuerySet.name. If the caller does not have permission
7796
+ # to create the SampleQuerySet, regardless of whether or not it exists, a `
7797
+ # PERMISSION_DENIED` error is returned. This field must be unique among all
7798
+ # SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is
7799
+ # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
7800
+ # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
7801
+ # INVALID_ARGUMENT` error is returned.
7802
+ # @param [String] fields
7803
+ # Selector specifying which fields to include in a partial response.
7804
+ # @param [String] quota_user
7805
+ # Available to use for quota purposes for server-side applications. Can be any
7806
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7807
+ # @param [Google::Apis::RequestOptions] options
7808
+ # Request-specific options
7809
+ #
7810
+ # @yield [result, err] Result & error if block supplied
7811
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet] parsed result object
7812
+ # @yieldparam err [StandardError] error object if request failed
7813
+ #
7814
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet]
7815
+ #
7816
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7817
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7818
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7819
+ def create_project_location_sample_query_set(parent, google_cloud_discoveryengine_v1beta_sample_query_set_object = nil, sample_query_set_id: nil, fields: nil, quota_user: nil, options: nil, &block)
7820
+ command = make_simple_command(:post, 'v1beta/{+parent}/sampleQuerySets', options)
7821
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet::Representation
7822
+ command.request_object = google_cloud_discoveryengine_v1beta_sample_query_set_object
7823
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet::Representation
7824
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet
7825
+ command.params['parent'] = parent unless parent.nil?
7826
+ command.query['sampleQuerySetId'] = sample_query_set_id unless sample_query_set_id.nil?
7827
+ command.query['fields'] = fields unless fields.nil?
7828
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7829
+ execute_or_queue_command(command, &block)
7830
+ end
7831
+
7832
+ # Deletes a SampleQuerySet.
7833
+ # @param [String] name
7834
+ # Required. Full resource name of SampleQuerySet, such as `projects/`project`/
7835
+ # locations/`location`/sampleQuerySets/`sample_query_set``. If the caller does
7836
+ # not have permission to delete the SampleQuerySet, regardless of whether or not
7837
+ # it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to
7838
+ # delete does not exist, a `NOT_FOUND` error is returned.
7839
+ # @param [String] fields
7840
+ # Selector specifying which fields to include in a partial response.
7841
+ # @param [String] quota_user
7842
+ # Available to use for quota purposes for server-side applications. Can be any
7843
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7844
+ # @param [Google::Apis::RequestOptions] options
7845
+ # Request-specific options
7846
+ #
7847
+ # @yield [result, err] Result & error if block supplied
7848
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
7849
+ # @yieldparam err [StandardError] error object if request failed
7850
+ #
7851
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
7852
+ #
7853
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7854
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7855
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7856
+ def delete_project_location_sample_query_set(name, fields: nil, quota_user: nil, options: nil, &block)
7857
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
7858
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
7859
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
7860
+ command.params['name'] = name unless name.nil?
7861
+ command.query['fields'] = fields unless fields.nil?
7862
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7863
+ execute_or_queue_command(command, &block)
7864
+ end
7865
+
7866
+ # Gets a SampleQuerySet.
7867
+ # @param [String] name
7868
+ # Required. Full resource name of SampleQuerySet, such as `projects/`project`/
7869
+ # locations/`location`/sampleQuerySets/`sample_query_set``. If the caller does
7870
+ # not have permission to access the SampleQuerySet, regardless of whether or not
7871
+ # it exists, a PERMISSION_DENIED error is returned. If the requested
7872
+ # SampleQuerySet does not exist, a NOT_FOUND error is returned.
7873
+ # @param [String] fields
7874
+ # Selector specifying which fields to include in a partial response.
7875
+ # @param [String] quota_user
7876
+ # Available to use for quota purposes for server-side applications. Can be any
7877
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7878
+ # @param [Google::Apis::RequestOptions] options
7879
+ # Request-specific options
7880
+ #
7881
+ # @yield [result, err] Result & error if block supplied
7882
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet] parsed result object
7883
+ # @yieldparam err [StandardError] error object if request failed
7884
+ #
7885
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet]
7886
+ #
7887
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7888
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7889
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7890
+ def get_project_location_sample_query_set(name, fields: nil, quota_user: nil, options: nil, &block)
7891
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
7892
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet::Representation
7893
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet
7894
+ command.params['name'] = name unless name.nil?
7895
+ command.query['fields'] = fields unless fields.nil?
7896
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7897
+ execute_or_queue_command(command, &block)
7898
+ end
7899
+
7900
+ # Gets a list of SampleQuerySets.
7901
+ # @param [String] parent
7902
+ # Required. The parent location resource name, such as `projects/`project`/
7903
+ # locations/`location``. If the caller does not have permission to list
7904
+ # SampleQuerySets under this location, regardless of whether or not this
7905
+ # location exists, a `PERMISSION_DENIED` error is returned.
7906
+ # @param [Fixnum] page_size
7907
+ # Maximum number of SampleQuerySets to return. If unspecified, defaults to 100.
7908
+ # The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
7909
+ # If this field is negative, an `INVALID_ARGUMENT` error is returned.
7910
+ # @param [String] page_token
7911
+ # A page token ListSampleQuerySetsResponse.next_page_token, received from a
7912
+ # previous SampleQuerySetService.ListSampleQuerySets call. Provide this to
7913
+ # retrieve the subsequent page. When paginating, all other parameters provided
7914
+ # to SampleQuerySetService.ListSampleQuerySets must match the call that provided
7915
+ # the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
7916
+ # @param [String] fields
7917
+ # Selector specifying which fields to include in a partial response.
7918
+ # @param [String] quota_user
7919
+ # Available to use for quota purposes for server-side applications. Can be any
7920
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7921
+ # @param [Google::Apis::RequestOptions] options
7922
+ # Request-specific options
7923
+ #
7924
+ # @yield [result, err] Result & error if block supplied
7925
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse] parsed result object
7926
+ # @yieldparam err [StandardError] error object if request failed
7927
+ #
7928
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse]
7929
+ #
7930
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7931
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7932
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7933
+ def list_project_location_sample_query_sets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7934
+ command = make_simple_command(:get, 'v1beta/{+parent}/sampleQuerySets', options)
7935
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse::Representation
7936
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse
7937
+ command.params['parent'] = parent unless parent.nil?
7938
+ command.query['pageSize'] = page_size unless page_size.nil?
7939
+ command.query['pageToken'] = page_token unless page_token.nil?
7940
+ command.query['fields'] = fields unless fields.nil?
7941
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7942
+ execute_or_queue_command(command, &block)
7943
+ end
7944
+
7945
+ # Updates a SampleQuerySet.
7946
+ # @param [String] name
7947
+ # Identifier. The full resource name of the SampleQuerySet, in the format of `
7948
+ # projects/`project`/locations/`location`/sampleQuerySets/`sample_query_set``.
7949
+ # This field must be a UTF-8 encoded string with a length limit of 1024
7950
+ # characters.
7951
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet] google_cloud_discoveryengine_v1beta_sample_query_set_object
7952
+ # @param [String] update_mask
7953
+ # Indicates which fields in the provided imported 'sample query set' to update.
7954
+ # If not set, will by default update all fields.
7955
+ # @param [String] fields
7956
+ # Selector specifying which fields to include in a partial response.
7957
+ # @param [String] quota_user
7958
+ # Available to use for quota purposes for server-side applications. Can be any
7959
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7960
+ # @param [Google::Apis::RequestOptions] options
7961
+ # Request-specific options
7962
+ #
7963
+ # @yield [result, err] Result & error if block supplied
7964
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet] parsed result object
7965
+ # @yieldparam err [StandardError] error object if request failed
7966
+ #
7967
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet]
7968
+ #
7969
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7970
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7971
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7972
+ def patch_project_location_sample_query_set(name, google_cloud_discoveryengine_v1beta_sample_query_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
7973
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
7974
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet::Representation
7975
+ command.request_object = google_cloud_discoveryengine_v1beta_sample_query_set_object
7976
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet::Representation
7977
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet
7978
+ command.params['name'] = name unless name.nil?
7979
+ command.query['updateMask'] = update_mask unless update_mask.nil?
7980
+ command.query['fields'] = fields unless fields.nil?
7981
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7982
+ execute_or_queue_command(command, &block)
7983
+ end
7984
+
7985
+ # Gets the latest state of a long-running operation. Clients can use this method
7986
+ # to poll the operation result at intervals as recommended by the API service.
7987
+ # @param [String] name
7988
+ # The name of the operation resource.
7989
+ # @param [String] fields
7990
+ # Selector specifying which fields to include in a partial response.
7991
+ # @param [String] quota_user
7992
+ # Available to use for quota purposes for server-side applications. Can be any
7993
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7994
+ # @param [Google::Apis::RequestOptions] options
7995
+ # Request-specific options
7996
+ #
7997
+ # @yield [result, err] Result & error if block supplied
7998
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
7999
+ # @yieldparam err [StandardError] error object if request failed
8000
+ #
8001
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
8002
+ #
8003
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8004
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8005
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8006
+ def get_project_location_sample_query_set_operation(name, fields: nil, quota_user: nil, options: nil, &block)
8007
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
8008
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
8009
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
8010
+ command.params['name'] = name unless name.nil?
8011
+ command.query['fields'] = fields unless fields.nil?
8012
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8013
+ execute_or_queue_command(command, &block)
8014
+ end
8015
+
8016
+ # Creates a SampleQuery
8017
+ # @param [String] parent
8018
+ # Required. The parent resource name, such as `projects/`project`/locations/`
8019
+ # location`/sampleQuerySets/`sampleQuerySet``.
8020
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery] google_cloud_discoveryengine_v1beta_sample_query_object
8021
+ # @param [String] sample_query_id
8022
+ # Required. The ID to use for the SampleQuery, which will become the final
8023
+ # component of the SampleQuery.name. If the caller does not have permission to
8024
+ # create the SampleQuery, regardless of whether or not it exists, a `
8025
+ # PERMISSION_DENIED` error is returned. This field must be unique among all
8026
+ # SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is
8027
+ # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
8028
+ # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
8029
+ # INVALID_ARGUMENT` error is returned.
8030
+ # @param [String] fields
8031
+ # Selector specifying which fields to include in a partial response.
8032
+ # @param [String] quota_user
8033
+ # Available to use for quota purposes for server-side applications. Can be any
8034
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8035
+ # @param [Google::Apis::RequestOptions] options
8036
+ # Request-specific options
8037
+ #
8038
+ # @yield [result, err] Result & error if block supplied
8039
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery] parsed result object
8040
+ # @yieldparam err [StandardError] error object if request failed
8041
+ #
8042
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery]
8043
+ #
8044
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8045
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8046
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8047
+ def create_project_location_sample_query_set_sample_query(parent, google_cloud_discoveryengine_v1beta_sample_query_object = nil, sample_query_id: nil, fields: nil, quota_user: nil, options: nil, &block)
8048
+ command = make_simple_command(:post, 'v1beta/{+parent}/sampleQueries', options)
8049
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery::Representation
8050
+ command.request_object = google_cloud_discoveryengine_v1beta_sample_query_object
8051
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery::Representation
8052
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery
8053
+ command.params['parent'] = parent unless parent.nil?
8054
+ command.query['sampleQueryId'] = sample_query_id unless sample_query_id.nil?
8055
+ command.query['fields'] = fields unless fields.nil?
8056
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8057
+ execute_or_queue_command(command, &block)
8058
+ end
8059
+
8060
+ # Deletes a SampleQuery.
8061
+ # @param [String] name
8062
+ # Required. Full resource name of SampleQuery, such as `projects/`project`/
8063
+ # locations/`location`/sampleQuerySets/`sample_query_set`/sampleQueries/`
8064
+ # sample_query``. If the caller does not have permission to delete the
8065
+ # SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED`
8066
+ # error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND`
8067
+ # error is returned.
8068
+ # @param [String] fields
8069
+ # Selector specifying which fields to include in a partial response.
8070
+ # @param [String] quota_user
8071
+ # Available to use for quota purposes for server-side applications. Can be any
8072
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8073
+ # @param [Google::Apis::RequestOptions] options
8074
+ # Request-specific options
8075
+ #
8076
+ # @yield [result, err] Result & error if block supplied
8077
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
8078
+ # @yieldparam err [StandardError] error object if request failed
8079
+ #
8080
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
8081
+ #
8082
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8083
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8084
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8085
+ def delete_project_location_sample_query_set_sample_query(name, fields: nil, quota_user: nil, options: nil, &block)
8086
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
8087
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
8088
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
8089
+ command.params['name'] = name unless name.nil?
8090
+ command.query['fields'] = fields unless fields.nil?
8091
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8092
+ execute_or_queue_command(command, &block)
8093
+ end
8094
+
8095
+ # Gets a SampleQuery.
8096
+ # @param [String] name
8097
+ # Required. Full resource name of SampleQuery, such as `projects/`project`/
8098
+ # locations/`location`/sampleQuerySets/`sample_query_set`/sampleQueries/`
8099
+ # sample_query``. If the caller does not have permission to access the
8100
+ # SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error
8101
+ # is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is
8102
+ # returned.
8103
+ # @param [String] fields
8104
+ # Selector specifying which fields to include in a partial response.
8105
+ # @param [String] quota_user
8106
+ # Available to use for quota purposes for server-side applications. Can be any
8107
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8108
+ # @param [Google::Apis::RequestOptions] options
8109
+ # Request-specific options
8110
+ #
8111
+ # @yield [result, err] Result & error if block supplied
8112
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery] parsed result object
8113
+ # @yieldparam err [StandardError] error object if request failed
8114
+ #
8115
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery]
8116
+ #
8117
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8118
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8119
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8120
+ def get_project_location_sample_query_set_sample_query(name, fields: nil, quota_user: nil, options: nil, &block)
8121
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
8122
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery::Representation
8123
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery
8124
+ command.params['name'] = name unless name.nil?
8125
+ command.query['fields'] = fields unless fields.nil?
8126
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8127
+ execute_or_queue_command(command, &block)
8128
+ end
8129
+
8130
+ # Bulk import of multiple SampleQuerys. Sample queries that already exist may be
8131
+ # deleted. Note: It is possible for a subset of the SampleQuerys to be
8132
+ # successfully imported.
8133
+ # @param [String] parent
8134
+ # Required. The parent sample query set resource name, such as `projects/`
8135
+ # project`/locations/`location`/sampleQuerySets/`sampleQuerySet``. If the caller
8136
+ # does not have permission to list SampleQuerys under this sample query set,
8137
+ # regardless of whether or not this sample query set exists, a `
8138
+ # PERMISSION_DENIED` error is returned.
8139
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest] google_cloud_discoveryengine_v1beta_import_sample_queries_request_object
8140
+ # @param [String] fields
8141
+ # Selector specifying which fields to include in a partial response.
8142
+ # @param [String] quota_user
8143
+ # Available to use for quota purposes for server-side applications. Can be any
8144
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8145
+ # @param [Google::Apis::RequestOptions] options
8146
+ # Request-specific options
8147
+ #
8148
+ # @yield [result, err] Result & error if block supplied
8149
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
8150
+ # @yieldparam err [StandardError] error object if request failed
8151
+ #
8152
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
8153
+ #
8154
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8155
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8156
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8157
+ def import_project_location_sample_query_set_sample_query(parent, google_cloud_discoveryengine_v1beta_import_sample_queries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
8158
+ command = make_simple_command(:post, 'v1beta/{+parent}/sampleQueries:import', options)
8159
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest::Representation
8160
+ command.request_object = google_cloud_discoveryengine_v1beta_import_sample_queries_request_object
8161
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
8162
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
8163
+ command.params['parent'] = parent unless parent.nil?
8164
+ command.query['fields'] = fields unless fields.nil?
8165
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8166
+ execute_or_queue_command(command, &block)
8167
+ end
8168
+
8169
+ # Gets a list of SampleQuerys.
8170
+ # @param [String] parent
8171
+ # Required. The parent sample query set resource name, such as `projects/`
8172
+ # project`/locations/`location`/sampleQuerySets/`sampleQuerySet``. If the caller
8173
+ # does not have permission to list SampleQuerys under this sample query set,
8174
+ # regardless of whether or not this sample query set exists, a `
8175
+ # PERMISSION_DENIED` error is returned.
8176
+ # @param [Fixnum] page_size
8177
+ # Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The
8178
+ # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
8179
+ # this field is negative, an `INVALID_ARGUMENT` error is returned.
8180
+ # @param [String] page_token
8181
+ # A page token ListSampleQueriesResponse.next_page_token, received from a
8182
+ # previous SampleQueryService.ListSampleQueries call. Provide this to retrieve
8183
+ # the subsequent page. When paginating, all other parameters provided to
8184
+ # SampleQueryService.ListSampleQueries must match the call that provided the
8185
+ # page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
8186
+ # @param [String] fields
8187
+ # Selector specifying which fields to include in a partial response.
8188
+ # @param [String] quota_user
8189
+ # Available to use for quota purposes for server-side applications. Can be any
8190
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8191
+ # @param [Google::Apis::RequestOptions] options
8192
+ # Request-specific options
8193
+ #
8194
+ # @yield [result, err] Result & error if block supplied
8195
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse] parsed result object
8196
+ # @yieldparam err [StandardError] error object if request failed
8197
+ #
8198
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse]
8199
+ #
8200
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8201
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8202
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8203
+ def list_project_location_sample_query_set_sample_queries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
8204
+ command = make_simple_command(:get, 'v1beta/{+parent}/sampleQueries', options)
8205
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse::Representation
8206
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse
8207
+ command.params['parent'] = parent unless parent.nil?
8208
+ command.query['pageSize'] = page_size unless page_size.nil?
8209
+ command.query['pageToken'] = page_token unless page_token.nil?
8210
+ command.query['fields'] = fields unless fields.nil?
8211
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8212
+ execute_or_queue_command(command, &block)
8213
+ end
8214
+
8215
+ # Updates a SampleQuery.
8216
+ # @param [String] name
8217
+ # Identifier. The full resource name of the sample query, in the format of `
8218
+ # projects/`project`/locations/`location`/sampleQuerySets/`sample_query_set`/
8219
+ # sampleQueries/`sample_query``. This field must be a UTF-8 encoded string with
8220
+ # a length limit of 1024 characters.
8221
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery] google_cloud_discoveryengine_v1beta_sample_query_object
8222
+ # @param [String] update_mask
8223
+ # Indicates which fields in the provided imported 'simple query' to update. If
8224
+ # not set, will by default update all fields.
8225
+ # @param [String] fields
8226
+ # Selector specifying which fields to include in a partial response.
8227
+ # @param [String] quota_user
8228
+ # Available to use for quota purposes for server-side applications. Can be any
8229
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8230
+ # @param [Google::Apis::RequestOptions] options
8231
+ # Request-specific options
8232
+ #
8233
+ # @yield [result, err] Result & error if block supplied
8234
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery] parsed result object
8235
+ # @yieldparam err [StandardError] error object if request failed
8236
+ #
8237
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery]
8238
+ #
8239
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8240
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8241
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8242
+ def patch_project_location_sample_query_set_sample_query(name, google_cloud_discoveryengine_v1beta_sample_query_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
8243
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
8244
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery::Representation
8245
+ command.request_object = google_cloud_discoveryengine_v1beta_sample_query_object
8246
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery::Representation
8247
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery
8248
+ command.params['name'] = name unless name.nil?
8249
+ command.query['updateMask'] = update_mask unless update_mask.nil?
8250
+ command.query['fields'] = fields unless fields.nil?
8251
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8252
+ execute_or_queue_command(command, &block)
8253
+ end
8254
+
8255
+ # Writes a single user event from the browser. This uses a GET request to due to
8256
+ # browser restriction of POST-ing to a third-party domain. This method is used
8257
+ # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
8258
+ # Users should not call this method directly.
8259
+ # @param [String] parent
8260
+ # Required. The parent DataStore resource name, such as `projects/`project`/
8261
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
8262
+ # @param [Fixnum] ets
8263
+ # The event timestamp in milliseconds. This prevents browser caching of
8264
+ # otherwise identical get requests. The name is abbreviated to reduce the
8265
+ # payload bytes.
8266
+ # @param [String] uri
8267
+ # The URL including cgi-parameters but excluding the hash fragment with a length
8268
+ # limit of 5,000 characters. This is often more useful than the referer URL,
8269
+ # because many browsers only send the domain for third-party requests.
8270
+ # @param [String] user_event
8271
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
6952
8272
  # characters.
6953
8273
  # @param [String] fields
6954
8274
  # Selector specifying which fields to include in a partial response.
@@ -6980,6 +8300,44 @@ module Google
6980
8300
  execute_or_queue_command(command, &block)
6981
8301
  end
6982
8302
 
8303
+ # Bulk import of user events. Request processing might be synchronous. Events
8304
+ # that already exist are skipped. Use this method for backfilling historical
8305
+ # user events. Operation.response is of type ImportResponse. Note that it is
8306
+ # possible for a subset of the items to be successfully inserted. Operation.
8307
+ # metadata is of type ImportMetadata.
8308
+ # @param [String] parent
8309
+ # Required. Parent DataStore resource name, of the form `projects/`project`/
8310
+ # locations/`location`/collections/`collection`/dataStores/`data_store``
8311
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest] google_cloud_discoveryengine_v1beta_import_user_events_request_object
8312
+ # @param [String] fields
8313
+ # Selector specifying which fields to include in a partial response.
8314
+ # @param [String] quota_user
8315
+ # Available to use for quota purposes for server-side applications. Can be any
8316
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8317
+ # @param [Google::Apis::RequestOptions] options
8318
+ # Request-specific options
8319
+ #
8320
+ # @yield [result, err] Result & error if block supplied
8321
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
8322
+ # @yieldparam err [StandardError] error object if request failed
8323
+ #
8324
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
8325
+ #
8326
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8327
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8328
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8329
+ def import_project_location_user_event(parent, google_cloud_discoveryengine_v1beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
8330
+ command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:import', options)
8331
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest::Representation
8332
+ command.request_object = google_cloud_discoveryengine_v1beta_import_user_events_request_object
8333
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
8334
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
8335
+ command.params['parent'] = parent unless parent.nil?
8336
+ command.query['fields'] = fields unless fields.nil?
8337
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8338
+ execute_or_queue_command(command, &block)
8339
+ end
8340
+
6983
8341
  # Writes a single user event.
6984
8342
  # @param [String] parent
6985
8343
  # Required. The parent resource name. If the write user event action is applied