google-apis-discoveryengine_v1alpha 0.46.0 → 0.48.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -581,8 +581,8 @@ module Google
581
581
  # permission to list DataStores under this location, regardless of whether or
582
582
  # not this data store exists, a PERMISSION_DENIED error is returned.
583
583
  # @param [String] filter
584
- # Filter by solution type . For example: filter = 'solution_type:
585
- # SOLUTION_TYPE_SEARCH'
584
+ # Filter by solution type . For example: `filter = 'solution_type:
585
+ # SOLUTION_TYPE_SEARCH'`
586
586
  # @param [Fixnum] page_size
587
587
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
588
588
  # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
@@ -745,14 +745,14 @@ module Google
745
745
  # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
746
746
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
747
747
  # @param [String] document_id
748
- # Required. The ID to use for the Document, which will become the final
749
- # component of the Document.name. If the caller does not have permission to
750
- # create the Document, regardless of whether or not it exists, a `
751
- # PERMISSION_DENIED` error is returned. This field must be unique among all
752
- # Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
753
- # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
754
- # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
755
- # INVALID_ARGUMENT` error is returned.
748
+ # Required. The ID to use for the Document, which becomes the final component of
749
+ # the Document.name. If the caller does not have permission to create the
750
+ # Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
751
+ # is returned. This field must be unique among all Documents with the same
752
+ # parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
753
+ # conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
754
+ # length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
755
+ # returned.
756
756
  # @param [String] fields
757
757
  # Selector specifying which fields to include in a partial response.
758
758
  # @param [String] quota_user
@@ -895,8 +895,8 @@ module Google
895
895
  end
896
896
 
897
897
  # Bulk import of multiple Documents. Request processing may be synchronous. Non-
898
- # existing items will be created. Note: It is possible for a subset of the
899
- # Documents to be successfully updated.
898
+ # existing items are created. Note: It is possible for a subset of the Documents
899
+ # to be successfully updated.
900
900
  # @param [String] parent
901
901
  # Required. The parent branch resource name, such as `projects/`project`/
902
902
  # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
@@ -941,8 +941,8 @@ module Google
941
941
  # PERMISSION_DENIED` error is returned.
942
942
  # @param [Fixnum] page_size
943
943
  # Maximum number of Documents to return. If unspecified, defaults to 100. The
944
- # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
945
- # this field is negative, an `INVALID_ARGUMENT` error is returned.
944
+ # maximum allowed value is 1000. Values above 1000 are set to 1000. If this
945
+ # field is negative, an `INVALID_ARGUMENT` error is returned.
946
946
  # @param [String] page_token
947
947
  # A page token ListDocumentsResponse.next_page_token, received from a previous
948
948
  # DocumentService.ListDocuments call. Provide this to retrieve the subsequent
@@ -986,10 +986,10 @@ module Google
986
986
  # with a length limit of 1024 characters.
987
987
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
988
988
  # @param [Boolean] allow_missing
989
- # If set to true, and the Document is not found, a new Document will be created.
989
+ # If set to `true` and the Document is not found, a new Document is be created.
990
990
  # @param [String] update_mask
991
991
  # Indicates which fields in the provided imported 'document' to update. If not
992
- # set, will by default update all fields.
992
+ # set, by default updates all fields.
993
993
  # @param [String] fields
994
994
  # Selector specifying which fields to include in a partial response.
995
995
  # @param [String] quota_user
@@ -1252,6 +1252,197 @@ module Google
1252
1252
  execute_or_queue_command(command, &block)
1253
1253
  end
1254
1254
 
1255
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
1256
+ # request can be submitted to adjust this limit. If the Control to create
1257
+ # already exists, an ALREADY_EXISTS error is returned.
1258
+ # @param [String] parent
1259
+ # Required. Full resource name of parent data store. Format: `projects/`
1260
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
1261
+ # `data_store_id``
1262
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
1263
+ # @param [String] control_id
1264
+ # Required. The ID to use for the Control, which will become the final component
1265
+ # of the Control's resource name. This value must be within 1-63 characters.
1266
+ # Valid characters are /a-z-_/.
1267
+ # @param [String] fields
1268
+ # Selector specifying which fields to include in a partial response.
1269
+ # @param [String] quota_user
1270
+ # Available to use for quota purposes for server-side applications. Can be any
1271
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1272
+ # @param [Google::Apis::RequestOptions] options
1273
+ # Request-specific options
1274
+ #
1275
+ # @yield [result, err] Result & error if block supplied
1276
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
1277
+ # @yieldparam err [StandardError] error object if request failed
1278
+ #
1279
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
1280
+ #
1281
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1282
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1283
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1284
+ def create_project_location_collection_data_store_control(parent, google_cloud_discoveryengine_v1alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1285
+ command = make_simple_command(:post, 'v1alpha/{+parent}/controls', options)
1286
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
1287
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
1288
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
1289
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
1290
+ command.params['parent'] = parent unless parent.nil?
1291
+ command.query['controlId'] = control_id unless control_id.nil?
1292
+ command.query['fields'] = fields unless fields.nil?
1293
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1294
+ execute_or_queue_command(command, &block)
1295
+ end
1296
+
1297
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
1298
+ # is returned.
1299
+ # @param [String] name
1300
+ # Required. The resource name of the Control to delete. Format: `projects/`
1301
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
1302
+ # `data_store_id`/controls/`control_id``
1303
+ # @param [String] fields
1304
+ # Selector specifying which fields to include in a partial response.
1305
+ # @param [String] quota_user
1306
+ # Available to use for quota purposes for server-side applications. Can be any
1307
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1308
+ # @param [Google::Apis::RequestOptions] options
1309
+ # Request-specific options
1310
+ #
1311
+ # @yield [result, err] Result & error if block supplied
1312
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
1313
+ # @yieldparam err [StandardError] error object if request failed
1314
+ #
1315
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
1316
+ #
1317
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1318
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1319
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1320
+ def delete_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
1321
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1322
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
1323
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
1324
+ command.params['name'] = name unless name.nil?
1325
+ command.query['fields'] = fields unless fields.nil?
1326
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1327
+ execute_or_queue_command(command, &block)
1328
+ end
1329
+
1330
+ # Gets a Control.
1331
+ # @param [String] name
1332
+ # Required. The resource name of the Control to get. Format: `projects/`
1333
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
1334
+ # `data_store_id`/controls/`control_id``
1335
+ # @param [String] fields
1336
+ # Selector specifying which fields to include in a partial response.
1337
+ # @param [String] quota_user
1338
+ # Available to use for quota purposes for server-side applications. Can be any
1339
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1340
+ # @param [Google::Apis::RequestOptions] options
1341
+ # Request-specific options
1342
+ #
1343
+ # @yield [result, err] Result & error if block supplied
1344
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
1345
+ # @yieldparam err [StandardError] error object if request failed
1346
+ #
1347
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
1348
+ #
1349
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1350
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1351
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1352
+ def get_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
1353
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1354
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
1355
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
1356
+ command.params['name'] = name unless name.nil?
1357
+ command.query['fields'] = fields unless fields.nil?
1358
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1359
+ execute_or_queue_command(command, &block)
1360
+ end
1361
+
1362
+ # Lists all Controls by their parent DataStore.
1363
+ # @param [String] parent
1364
+ # Required. The data store resource name. Format: `projects/`project_number`/
1365
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
1366
+ # @param [String] filter
1367
+ # Optional. A filter to apply on the list results. Supported features: * List
1368
+ # all the products under the parent branch if filter is unset. Currently this
1369
+ # field is unsupported.
1370
+ # @param [Fixnum] page_size
1371
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
1372
+ # Max allowed value is 1000.
1373
+ # @param [String] page_token
1374
+ # Optional. A page token, received from a previous `ListControls` call. Provide
1375
+ # this to retrieve the subsequent page.
1376
+ # @param [String] fields
1377
+ # Selector specifying which fields to include in a partial response.
1378
+ # @param [String] quota_user
1379
+ # Available to use for quota purposes for server-side applications. Can be any
1380
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1381
+ # @param [Google::Apis::RequestOptions] options
1382
+ # Request-specific options
1383
+ #
1384
+ # @yield [result, err] Result & error if block supplied
1385
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse] parsed result object
1386
+ # @yieldparam err [StandardError] error object if request failed
1387
+ #
1388
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse]
1389
+ #
1390
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1391
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1392
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1393
+ def list_project_location_collection_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1394
+ command = make_simple_command(:get, 'v1alpha/{+parent}/controls', options)
1395
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse::Representation
1396
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse
1397
+ command.params['parent'] = parent unless parent.nil?
1398
+ command.query['filter'] = filter unless filter.nil?
1399
+ command.query['pageSize'] = page_size unless page_size.nil?
1400
+ command.query['pageToken'] = page_token unless page_token.nil?
1401
+ command.query['fields'] = fields unless fields.nil?
1402
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1403
+ execute_or_queue_command(command, &block)
1404
+ end
1405
+
1406
+ # Updates a Control. Control action type cannot be changed. If the Control to
1407
+ # update does not exist, a NOT_FOUND error is returned.
1408
+ # @param [String] name
1409
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
1410
+ # controls/*`
1411
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
1412
+ # @param [String] update_mask
1413
+ # Optional. Indicates which fields in the provided Control to update. The
1414
+ # following are NOT supported: * Control.name * Control.solution_type If not set
1415
+ # or empty, all supported fields are updated.
1416
+ # @param [String] fields
1417
+ # Selector specifying which fields to include in a partial response.
1418
+ # @param [String] quota_user
1419
+ # Available to use for quota purposes for server-side applications. Can be any
1420
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1421
+ # @param [Google::Apis::RequestOptions] options
1422
+ # Request-specific options
1423
+ #
1424
+ # @yield [result, err] Result & error if block supplied
1425
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
1426
+ # @yieldparam err [StandardError] error object if request failed
1427
+ #
1428
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
1429
+ #
1430
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1431
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1432
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1433
+ def patch_project_location_collection_data_store_control(name, google_cloud_discoveryengine_v1alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1434
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1435
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
1436
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
1437
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
1438
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
1439
+ command.params['name'] = name unless name.nil?
1440
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1441
+ command.query['fields'] = fields unless fields.nil?
1442
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1443
+ execute_or_queue_command(command, &block)
1444
+ end
1445
+
1255
1446
  # Converses a conversation.
1256
1447
  # @param [String] name
1257
1448
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -1661,8 +1852,8 @@ module Google
1661
1852
  # .
1662
1853
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
1663
1854
  # @param [String] schema_id
1664
- # Required. The ID to use for the Schema, which will become the final component
1665
- # of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
1855
+ # Required. The ID to use for the Schema, which becomes the final component of
1856
+ # the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
1666
1857
  # org/html/rfc1034) standard with a length limit of 63 characters.
1667
1858
  # @param [String] fields
1668
1859
  # Selector specifying which fields to include in a partial response.
@@ -1765,8 +1956,8 @@ module Google
1765
1956
  # .
1766
1957
  # @param [Fixnum] page_size
1767
1958
  # The maximum number of Schemas to return. The service may return fewer than
1768
- # this value. If unspecified, at most 100 Schemas will be returned. The maximum
1769
- # value is 1000; values above 1000 will be coerced to 1000.
1959
+ # this value. If unspecified, at most 100 Schemas are returned. The maximum
1960
+ # value is 1000; values above 1000 are set to 1000.
1770
1961
  # @param [String] page_token
1771
1962
  # A page token, received from a previous SchemaService.ListSchemas call. Provide
1772
1963
  # this to retrieve the subsequent page. When paginating, all other parameters
@@ -1809,8 +2000,8 @@ module Google
1809
2000
  # limit of 1024 characters.
1810
2001
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
1811
2002
  # @param [Boolean] allow_missing
1812
- # If set to true, and the Schema is not found, a new Schema will be created. In
1813
- # this situation, `update_mask` is ignored.
2003
+ # If set to true, and the Schema is not found, a new Schema is created. In this
2004
+ # situation, `update_mask` is ignored.
1814
2005
  # @param [String] fields
1815
2006
  # Selector specifying which fields to include in a partial response.
1816
2007
  # @param [String] quota_user
@@ -2068,11 +2259,11 @@ module Google
2068
2259
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
2069
2260
  # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
2070
2261
  # collections/*/dataStores/*/servingConfigs/*` One default serving config is
2071
- # created along with your recommendation engine creation. The engine ID will be
2072
- # used as the ID of the default serving config. For example, for Engine `
2073
- # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
2074
- # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
2075
- # engine` for your RecommendationService.Recommend requests.
2262
+ # created along with your recommendation engine creation. The engine ID is used
2263
+ # as the ID of the default serving config. For example, for Engine `projects/*/
2264
+ # locations/global/collections/*/engines/my-engine`, you can use `projects/*/
2265
+ # locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
2266
+ # your RecommendationService.Recommend requests.
2076
2267
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
2077
2268
  # @param [String] fields
2078
2269
  # Selector specifying which fields to include in a partial response.
@@ -3025,7 +3216,7 @@ module Google
3025
3216
  execute_or_queue_command(command, &block)
3026
3217
  end
3027
3218
 
3028
- # Bulk import of User events. Request processing might be synchronous. Events
3219
+ # Bulk import of user events. Request processing might be synchronous. Events
3029
3220
  # that already exist are skipped. Use this method for backfilling historical
3030
3221
  # user events. Operation.response is of type ImportResponse. Note that it is
3031
3222
  # possible for a subset of the items to be successfully inserted. Operation.
@@ -3110,6 +3301,9 @@ module Google
3110
3301
  # across multiple DataStore, the format is: `projects/`project`/locations/`
3111
3302
  # location``.
3112
3303
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
3304
+ # @param [Boolean] write_async
3305
+ # If set to true, the user event is written asynchronously after validation, and
3306
+ # the API responds without waiting for the write.
3113
3307
  # @param [String] fields
3114
3308
  # Selector specifying which fields to include in a partial response.
3115
3309
  # @param [String] quota_user
@@ -3127,13 +3321,14 @@ module Google
3127
3321
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3128
3322
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3129
3323
  # @raise [Google::Apis::AuthorizationError] Authorization is required
3130
- def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3324
+ def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
3131
3325
  command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
3132
3326
  command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
3133
3327
  command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
3134
3328
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
3135
3329
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
3136
3330
  command.params['parent'] = parent unless parent.nil?
3331
+ command.query['writeAsync'] = write_async unless write_async.nil?
3137
3332
  command.query['fields'] = fields unless fields.nil?
3138
3333
  command.query['quotaUser'] = quota_user unless quota_user.nil?
3139
3334
  execute_or_queue_command(command, &block)
@@ -3432,6 +3627,197 @@ module Google
3432
3627
  execute_or_queue_command(command, &block)
3433
3628
  end
3434
3629
 
3630
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
3631
+ # request can be submitted to adjust this limit. If the Control to create
3632
+ # already exists, an ALREADY_EXISTS error is returned.
3633
+ # @param [String] parent
3634
+ # Required. Full resource name of parent data store. Format: `projects/`
3635
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3636
+ # `data_store_id``
3637
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
3638
+ # @param [String] control_id
3639
+ # Required. The ID to use for the Control, which will become the final component
3640
+ # of the Control's resource name. This value must be within 1-63 characters.
3641
+ # Valid characters are /a-z-_/.
3642
+ # @param [String] fields
3643
+ # Selector specifying which fields to include in a partial response.
3644
+ # @param [String] quota_user
3645
+ # Available to use for quota purposes for server-side applications. Can be any
3646
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3647
+ # @param [Google::Apis::RequestOptions] options
3648
+ # Request-specific options
3649
+ #
3650
+ # @yield [result, err] Result & error if block supplied
3651
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
3652
+ # @yieldparam err [StandardError] error object if request failed
3653
+ #
3654
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
3655
+ #
3656
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3657
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3658
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3659
+ def create_project_location_collection_engine_control(parent, google_cloud_discoveryengine_v1alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
3660
+ command = make_simple_command(:post, 'v1alpha/{+parent}/controls', options)
3661
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
3662
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
3663
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
3664
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
3665
+ command.params['parent'] = parent unless parent.nil?
3666
+ command.query['controlId'] = control_id unless control_id.nil?
3667
+ command.query['fields'] = fields unless fields.nil?
3668
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3669
+ execute_or_queue_command(command, &block)
3670
+ end
3671
+
3672
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
3673
+ # is returned.
3674
+ # @param [String] name
3675
+ # Required. The resource name of the Control to delete. Format: `projects/`
3676
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3677
+ # `data_store_id`/controls/`control_id``
3678
+ # @param [String] fields
3679
+ # Selector specifying which fields to include in a partial response.
3680
+ # @param [String] quota_user
3681
+ # Available to use for quota purposes for server-side applications. Can be any
3682
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3683
+ # @param [Google::Apis::RequestOptions] options
3684
+ # Request-specific options
3685
+ #
3686
+ # @yield [result, err] Result & error if block supplied
3687
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
3688
+ # @yieldparam err [StandardError] error object if request failed
3689
+ #
3690
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
3691
+ #
3692
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3693
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3694
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3695
+ def delete_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
3696
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
3697
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
3698
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
3699
+ command.params['name'] = name unless name.nil?
3700
+ command.query['fields'] = fields unless fields.nil?
3701
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3702
+ execute_or_queue_command(command, &block)
3703
+ end
3704
+
3705
+ # Gets a Control.
3706
+ # @param [String] name
3707
+ # Required. The resource name of the Control to get. Format: `projects/`
3708
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3709
+ # `data_store_id`/controls/`control_id``
3710
+ # @param [String] fields
3711
+ # Selector specifying which fields to include in a partial response.
3712
+ # @param [String] quota_user
3713
+ # Available to use for quota purposes for server-side applications. Can be any
3714
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3715
+ # @param [Google::Apis::RequestOptions] options
3716
+ # Request-specific options
3717
+ #
3718
+ # @yield [result, err] Result & error if block supplied
3719
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
3720
+ # @yieldparam err [StandardError] error object if request failed
3721
+ #
3722
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
3723
+ #
3724
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3725
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3726
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3727
+ def get_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
3728
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
3729
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
3730
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
3731
+ command.params['name'] = name unless name.nil?
3732
+ command.query['fields'] = fields unless fields.nil?
3733
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3734
+ execute_or_queue_command(command, &block)
3735
+ end
3736
+
3737
+ # Lists all Controls by their parent DataStore.
3738
+ # @param [String] parent
3739
+ # Required. The data store resource name. Format: `projects/`project_number`/
3740
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
3741
+ # @param [String] filter
3742
+ # Optional. A filter to apply on the list results. Supported features: * List
3743
+ # all the products under the parent branch if filter is unset. Currently this
3744
+ # field is unsupported.
3745
+ # @param [Fixnum] page_size
3746
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
3747
+ # Max allowed value is 1000.
3748
+ # @param [String] page_token
3749
+ # Optional. A page token, received from a previous `ListControls` call. Provide
3750
+ # this to retrieve the subsequent page.
3751
+ # @param [String] fields
3752
+ # Selector specifying which fields to include in a partial response.
3753
+ # @param [String] quota_user
3754
+ # Available to use for quota purposes for server-side applications. Can be any
3755
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3756
+ # @param [Google::Apis::RequestOptions] options
3757
+ # Request-specific options
3758
+ #
3759
+ # @yield [result, err] Result & error if block supplied
3760
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse] parsed result object
3761
+ # @yieldparam err [StandardError] error object if request failed
3762
+ #
3763
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse]
3764
+ #
3765
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3766
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3767
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3768
+ def list_project_location_collection_engine_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3769
+ command = make_simple_command(:get, 'v1alpha/{+parent}/controls', options)
3770
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse::Representation
3771
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse
3772
+ command.params['parent'] = parent unless parent.nil?
3773
+ command.query['filter'] = filter unless filter.nil?
3774
+ command.query['pageSize'] = page_size unless page_size.nil?
3775
+ command.query['pageToken'] = page_token unless page_token.nil?
3776
+ command.query['fields'] = fields unless fields.nil?
3777
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3778
+ execute_or_queue_command(command, &block)
3779
+ end
3780
+
3781
+ # Updates a Control. Control action type cannot be changed. If the Control to
3782
+ # update does not exist, a NOT_FOUND error is returned.
3783
+ # @param [String] name
3784
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
3785
+ # controls/*`
3786
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
3787
+ # @param [String] update_mask
3788
+ # Optional. Indicates which fields in the provided Control to update. The
3789
+ # following are NOT supported: * Control.name * Control.solution_type If not set
3790
+ # or empty, all supported fields are updated.
3791
+ # @param [String] fields
3792
+ # Selector specifying which fields to include in a partial response.
3793
+ # @param [String] quota_user
3794
+ # Available to use for quota purposes for server-side applications. Can be any
3795
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3796
+ # @param [Google::Apis::RequestOptions] options
3797
+ # Request-specific options
3798
+ #
3799
+ # @yield [result, err] Result & error if block supplied
3800
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
3801
+ # @yieldparam err [StandardError] error object if request failed
3802
+ #
3803
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
3804
+ #
3805
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3806
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3807
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3808
+ def patch_project_location_collection_engine_control(name, google_cloud_discoveryengine_v1alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3809
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
3810
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
3811
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
3812
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
3813
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
3814
+ command.params['name'] = name unless name.nil?
3815
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3816
+ command.query['fields'] = fields unless fields.nil?
3817
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3818
+ execute_or_queue_command(command, &block)
3819
+ end
3820
+
3435
3821
  # Converses a conversation.
3436
3822
  # @param [String] name
3437
3823
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -3887,11 +4273,11 @@ module Google
3887
4273
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
3888
4274
  # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
3889
4275
  # collections/*/dataStores/*/servingConfigs/*` One default serving config is
3890
- # created along with your recommendation engine creation. The engine ID will be
3891
- # used as the ID of the default serving config. For example, for Engine `
3892
- # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
3893
- # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
3894
- # engine` for your RecommendationService.Recommend requests.
4276
+ # created along with your recommendation engine creation. The engine ID is used
4277
+ # as the ID of the default serving config. For example, for Engine `projects/*/
4278
+ # locations/global/collections/*/engines/my-engine`, you can use `projects/*/
4279
+ # locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
4280
+ # your RecommendationService.Recommend requests.
3895
4281
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
3896
4282
  # @param [String] fields
3897
4283
  # Selector specifying which fields to include in a partial response.
@@ -4504,8 +4890,8 @@ module Google
4504
4890
  # permission to list DataStores under this location, regardless of whether or
4505
4891
  # not this data store exists, a PERMISSION_DENIED error is returned.
4506
4892
  # @param [String] filter
4507
- # Filter by solution type . For example: filter = 'solution_type:
4508
- # SOLUTION_TYPE_SEARCH'
4893
+ # Filter by solution type . For example: `filter = 'solution_type:
4894
+ # SOLUTION_TYPE_SEARCH'`
4509
4895
  # @param [Fixnum] page_size
4510
4896
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
4511
4897
  # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
@@ -4633,14 +5019,14 @@ module Google
4633
5019
  # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
4634
5020
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
4635
5021
  # @param [String] document_id
4636
- # Required. The ID to use for the Document, which will become the final
4637
- # component of the Document.name. If the caller does not have permission to
4638
- # create the Document, regardless of whether or not it exists, a `
4639
- # PERMISSION_DENIED` error is returned. This field must be unique among all
4640
- # Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
4641
- # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
4642
- # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
4643
- # INVALID_ARGUMENT` error is returned.
5022
+ # Required. The ID to use for the Document, which becomes the final component of
5023
+ # the Document.name. If the caller does not have permission to create the
5024
+ # Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
5025
+ # is returned. This field must be unique among all Documents with the same
5026
+ # parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
5027
+ # conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
5028
+ # length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
5029
+ # returned.
4644
5030
  # @param [String] fields
4645
5031
  # Selector specifying which fields to include in a partial response.
4646
5032
  # @param [String] quota_user
@@ -4783,8 +5169,8 @@ module Google
4783
5169
  end
4784
5170
 
4785
5171
  # Bulk import of multiple Documents. Request processing may be synchronous. Non-
4786
- # existing items will be created. Note: It is possible for a subset of the
4787
- # Documents to be successfully updated.
5172
+ # existing items are created. Note: It is possible for a subset of the Documents
5173
+ # to be successfully updated.
4788
5174
  # @param [String] parent
4789
5175
  # Required. The parent branch resource name, such as `projects/`project`/
4790
5176
  # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
@@ -4829,8 +5215,8 @@ module Google
4829
5215
  # PERMISSION_DENIED` error is returned.
4830
5216
  # @param [Fixnum] page_size
4831
5217
  # Maximum number of Documents to return. If unspecified, defaults to 100. The
4832
- # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
4833
- # this field is negative, an `INVALID_ARGUMENT` error is returned.
5218
+ # maximum allowed value is 1000. Values above 1000 are set to 1000. If this
5219
+ # field is negative, an `INVALID_ARGUMENT` error is returned.
4834
5220
  # @param [String] page_token
4835
5221
  # A page token ListDocumentsResponse.next_page_token, received from a previous
4836
5222
  # DocumentService.ListDocuments call. Provide this to retrieve the subsequent
@@ -4874,10 +5260,10 @@ module Google
4874
5260
  # with a length limit of 1024 characters.
4875
5261
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
4876
5262
  # @param [Boolean] allow_missing
4877
- # If set to true, and the Document is not found, a new Document will be created.
5263
+ # If set to `true` and the Document is not found, a new Document is be created.
4878
5264
  # @param [String] update_mask
4879
5265
  # Indicates which fields in the provided imported 'document' to update. If not
4880
- # set, will by default update all fields.
5266
+ # set, by default updates all fields.
4881
5267
  # @param [String] fields
4882
5268
  # Selector specifying which fields to include in a partial response.
4883
5269
  # @param [String] quota_user
@@ -5140,6 +5526,197 @@ module Google
5140
5526
  execute_or_queue_command(command, &block)
5141
5527
  end
5142
5528
 
5529
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
5530
+ # request can be submitted to adjust this limit. If the Control to create
5531
+ # already exists, an ALREADY_EXISTS error is returned.
5532
+ # @param [String] parent
5533
+ # Required. Full resource name of parent data store. Format: `projects/`
5534
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
5535
+ # `data_store_id``
5536
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
5537
+ # @param [String] control_id
5538
+ # Required. The ID to use for the Control, which will become the final component
5539
+ # of the Control's resource name. This value must be within 1-63 characters.
5540
+ # Valid characters are /a-z-_/.
5541
+ # @param [String] fields
5542
+ # Selector specifying which fields to include in a partial response.
5543
+ # @param [String] quota_user
5544
+ # Available to use for quota purposes for server-side applications. Can be any
5545
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5546
+ # @param [Google::Apis::RequestOptions] options
5547
+ # Request-specific options
5548
+ #
5549
+ # @yield [result, err] Result & error if block supplied
5550
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
5551
+ # @yieldparam err [StandardError] error object if request failed
5552
+ #
5553
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
5554
+ #
5555
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5556
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5557
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5558
+ def create_project_location_data_store_control(parent, google_cloud_discoveryengine_v1alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
5559
+ command = make_simple_command(:post, 'v1alpha/{+parent}/controls', options)
5560
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
5561
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
5562
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
5563
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
5564
+ command.params['parent'] = parent unless parent.nil?
5565
+ command.query['controlId'] = control_id unless control_id.nil?
5566
+ command.query['fields'] = fields unless fields.nil?
5567
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5568
+ execute_or_queue_command(command, &block)
5569
+ end
5570
+
5571
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
5572
+ # is returned.
5573
+ # @param [String] name
5574
+ # Required. The resource name of the Control to delete. Format: `projects/`
5575
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
5576
+ # `data_store_id`/controls/`control_id``
5577
+ # @param [String] fields
5578
+ # Selector specifying which fields to include in a partial response.
5579
+ # @param [String] quota_user
5580
+ # Available to use for quota purposes for server-side applications. Can be any
5581
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5582
+ # @param [Google::Apis::RequestOptions] options
5583
+ # Request-specific options
5584
+ #
5585
+ # @yield [result, err] Result & error if block supplied
5586
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
5587
+ # @yieldparam err [StandardError] error object if request failed
5588
+ #
5589
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
5590
+ #
5591
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5592
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5593
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5594
+ def delete_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
5595
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
5596
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
5597
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
5598
+ command.params['name'] = name unless name.nil?
5599
+ command.query['fields'] = fields unless fields.nil?
5600
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5601
+ execute_or_queue_command(command, &block)
5602
+ end
5603
+
5604
+ # Gets a Control.
5605
+ # @param [String] name
5606
+ # Required. The resource name of the Control to get. Format: `projects/`
5607
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
5608
+ # `data_store_id`/controls/`control_id``
5609
+ # @param [String] fields
5610
+ # Selector specifying which fields to include in a partial response.
5611
+ # @param [String] quota_user
5612
+ # Available to use for quota purposes for server-side applications. Can be any
5613
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5614
+ # @param [Google::Apis::RequestOptions] options
5615
+ # Request-specific options
5616
+ #
5617
+ # @yield [result, err] Result & error if block supplied
5618
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
5619
+ # @yieldparam err [StandardError] error object if request failed
5620
+ #
5621
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
5622
+ #
5623
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5624
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5625
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5626
+ def get_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
5627
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
5628
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
5629
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
5630
+ command.params['name'] = name unless name.nil?
5631
+ command.query['fields'] = fields unless fields.nil?
5632
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5633
+ execute_or_queue_command(command, &block)
5634
+ end
5635
+
5636
+ # Lists all Controls by their parent DataStore.
5637
+ # @param [String] parent
5638
+ # Required. The data store resource name. Format: `projects/`project_number`/
5639
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
5640
+ # @param [String] filter
5641
+ # Optional. A filter to apply on the list results. Supported features: * List
5642
+ # all the products under the parent branch if filter is unset. Currently this
5643
+ # field is unsupported.
5644
+ # @param [Fixnum] page_size
5645
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
5646
+ # Max allowed value is 1000.
5647
+ # @param [String] page_token
5648
+ # Optional. A page token, received from a previous `ListControls` call. Provide
5649
+ # this to retrieve the subsequent page.
5650
+ # @param [String] fields
5651
+ # Selector specifying which fields to include in a partial response.
5652
+ # @param [String] quota_user
5653
+ # Available to use for quota purposes for server-side applications. Can be any
5654
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5655
+ # @param [Google::Apis::RequestOptions] options
5656
+ # Request-specific options
5657
+ #
5658
+ # @yield [result, err] Result & error if block supplied
5659
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse] parsed result object
5660
+ # @yieldparam err [StandardError] error object if request failed
5661
+ #
5662
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse]
5663
+ #
5664
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5665
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5666
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5667
+ def list_project_location_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
5668
+ command = make_simple_command(:get, 'v1alpha/{+parent}/controls', options)
5669
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse::Representation
5670
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse
5671
+ command.params['parent'] = parent unless parent.nil?
5672
+ command.query['filter'] = filter unless filter.nil?
5673
+ command.query['pageSize'] = page_size unless page_size.nil?
5674
+ command.query['pageToken'] = page_token unless page_token.nil?
5675
+ command.query['fields'] = fields unless fields.nil?
5676
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5677
+ execute_or_queue_command(command, &block)
5678
+ end
5679
+
5680
+ # Updates a Control. Control action type cannot be changed. If the Control to
5681
+ # update does not exist, a NOT_FOUND error is returned.
5682
+ # @param [String] name
5683
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
5684
+ # controls/*`
5685
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
5686
+ # @param [String] update_mask
5687
+ # Optional. Indicates which fields in the provided Control to update. The
5688
+ # following are NOT supported: * Control.name * Control.solution_type If not set
5689
+ # or empty, all supported fields are updated.
5690
+ # @param [String] fields
5691
+ # Selector specifying which fields to include in a partial response.
5692
+ # @param [String] quota_user
5693
+ # Available to use for quota purposes for server-side applications. Can be any
5694
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5695
+ # @param [Google::Apis::RequestOptions] options
5696
+ # Request-specific options
5697
+ #
5698
+ # @yield [result, err] Result & error if block supplied
5699
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
5700
+ # @yieldparam err [StandardError] error object if request failed
5701
+ #
5702
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
5703
+ #
5704
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5705
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5706
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5707
+ def patch_project_location_data_store_control(name, google_cloud_discoveryengine_v1alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
5708
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
5709
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
5710
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
5711
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
5712
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
5713
+ command.params['name'] = name unless name.nil?
5714
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5715
+ command.query['fields'] = fields unless fields.nil?
5716
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5717
+ execute_or_queue_command(command, &block)
5718
+ end
5719
+
5143
5720
  # Converses a conversation.
5144
5721
  # @param [String] name
5145
5722
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -5517,8 +6094,8 @@ module Google
5517
6094
  # .
5518
6095
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
5519
6096
  # @param [String] schema_id
5520
- # Required. The ID to use for the Schema, which will become the final component
5521
- # of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
6097
+ # Required. The ID to use for the Schema, which becomes the final component of
6098
+ # the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
5522
6099
  # org/html/rfc1034) standard with a length limit of 63 characters.
5523
6100
  # @param [String] fields
5524
6101
  # Selector specifying which fields to include in a partial response.
@@ -5621,8 +6198,8 @@ module Google
5621
6198
  # .
5622
6199
  # @param [Fixnum] page_size
5623
6200
  # The maximum number of Schemas to return. The service may return fewer than
5624
- # this value. If unspecified, at most 100 Schemas will be returned. The maximum
5625
- # value is 1000; values above 1000 will be coerced to 1000.
6201
+ # this value. If unspecified, at most 100 Schemas are returned. The maximum
6202
+ # value is 1000; values above 1000 are set to 1000.
5626
6203
  # @param [String] page_token
5627
6204
  # A page token, received from a previous SchemaService.ListSchemas call. Provide
5628
6205
  # this to retrieve the subsequent page. When paginating, all other parameters
@@ -5665,8 +6242,8 @@ module Google
5665
6242
  # limit of 1024 characters.
5666
6243
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
5667
6244
  # @param [Boolean] allow_missing
5668
- # If set to true, and the Schema is not found, a new Schema will be created. In
5669
- # this situation, `update_mask` is ignored.
6245
+ # If set to true, and the Schema is not found, a new Schema is created. In this
6246
+ # situation, `update_mask` is ignored.
5670
6247
  # @param [String] fields
5671
6248
  # Selector specifying which fields to include in a partial response.
5672
6249
  # @param [String] quota_user
@@ -5853,11 +6430,11 @@ module Google
5853
6430
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
5854
6431
  # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
5855
6432
  # collections/*/dataStores/*/servingConfigs/*` One default serving config is
5856
- # created along with your recommendation engine creation. The engine ID will be
5857
- # used as the ID of the default serving config. For example, for Engine `
5858
- # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
5859
- # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
5860
- # engine` for your RecommendationService.Recommend requests.
6433
+ # created along with your recommendation engine creation. The engine ID is used
6434
+ # as the ID of the default serving config. For example, for Engine `projects/*/
6435
+ # locations/global/collections/*/engines/my-engine`, you can use `projects/*/
6436
+ # locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
6437
+ # your RecommendationService.Recommend requests.
5861
6438
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
5862
6439
  # @param [String] fields
5863
6440
  # Selector specifying which fields to include in a partial response.
@@ -6587,7 +7164,7 @@ module Google
6587
7164
  execute_or_queue_command(command, &block)
6588
7165
  end
6589
7166
 
6590
- # Bulk import of User events. Request processing might be synchronous. Events
7167
+ # Bulk import of user events. Request processing might be synchronous. Events
6591
7168
  # that already exist are skipped. Use this method for backfilling historical
6592
7169
  # user events. Operation.response is of type ImportResponse. Note that it is
6593
7170
  # possible for a subset of the items to be successfully inserted. Operation.
@@ -6672,6 +7249,9 @@ module Google
6672
7249
  # across multiple DataStore, the format is: `projects/`project`/locations/`
6673
7250
  # location``.
6674
7251
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
7252
+ # @param [Boolean] write_async
7253
+ # If set to true, the user event is written asynchronously after validation, and
7254
+ # the API responds without waiting for the write.
6675
7255
  # @param [String] fields
6676
7256
  # Selector specifying which fields to include in a partial response.
6677
7257
  # @param [String] quota_user
@@ -6689,13 +7269,14 @@ module Google
6689
7269
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6690
7270
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6691
7271
  # @raise [Google::Apis::AuthorizationError] Authorization is required
6692
- def write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7272
+ def write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
6693
7273
  command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
6694
7274
  command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6695
7275
  command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
6696
7276
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6697
7277
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
6698
7278
  command.params['parent'] = parent unless parent.nil?
7279
+ command.query['writeAsync'] = write_async unless write_async.nil?
6699
7280
  command.query['fields'] = fields unless fields.nil?
6700
7281
  command.query['quotaUser'] = quota_user unless quota_user.nil?
6701
7282
  execute_or_queue_command(command, &block)
@@ -6911,6 +7492,9 @@ module Google
6911
7492
  # across multiple DataStore, the format is: `projects/`project`/locations/`
6912
7493
  # location``.
6913
7494
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
7495
+ # @param [Boolean] write_async
7496
+ # If set to true, the user event is written asynchronously after validation, and
7497
+ # the API responds without waiting for the write.
6914
7498
  # @param [String] fields
6915
7499
  # Selector specifying which fields to include in a partial response.
6916
7500
  # @param [String] quota_user
@@ -6928,13 +7512,14 @@ module Google
6928
7512
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6929
7513
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6930
7514
  # @raise [Google::Apis::AuthorizationError] Authorization is required
6931
- def write_project_location_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7515
+ def write_project_location_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
6932
7516
  command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
6933
7517
  command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6934
7518
  command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
6935
7519
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6936
7520
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
6937
7521
  command.params['parent'] = parent unless parent.nil?
7522
+ command.query['writeAsync'] = write_async unless write_async.nil?
6938
7523
  command.query['fields'] = fields unless fields.nil?
6939
7524
  command.query['quotaUser'] = quota_user unless quota_user.nil?
6940
7525
  execute_or_queue_command(command, &block)