google-apis-discoveryengine_v1alpha 0.47.0 → 0.49.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
@@ -1252,6 +1252,200 @@ 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`` or `projects/`project_number`/locations/`location_id`/
1262
+ # collections/`collection_id`/engines/`engine_id``.
1263
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
1264
+ # @param [String] control_id
1265
+ # Required. The ID to use for the Control, which will become the final component
1266
+ # of the Control's resource name. This value must be within 1-63 characters.
1267
+ # Valid characters are /a-z-_/.
1268
+ # @param [String] fields
1269
+ # Selector specifying which fields to include in a partial response.
1270
+ # @param [String] quota_user
1271
+ # Available to use for quota purposes for server-side applications. Can be any
1272
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1273
+ # @param [Google::Apis::RequestOptions] options
1274
+ # Request-specific options
1275
+ #
1276
+ # @yield [result, err] Result & error if block supplied
1277
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
1278
+ # @yieldparam err [StandardError] error object if request failed
1279
+ #
1280
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
1281
+ #
1282
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1283
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1284
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1285
+ 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)
1286
+ command = make_simple_command(:post, 'v1alpha/{+parent}/controls', options)
1287
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
1288
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
1289
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
1290
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
1291
+ command.params['parent'] = parent unless parent.nil?
1292
+ command.query['controlId'] = control_id unless control_id.nil?
1293
+ command.query['fields'] = fields unless fields.nil?
1294
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1295
+ execute_or_queue_command(command, &block)
1296
+ end
1297
+
1298
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
1299
+ # is returned.
1300
+ # @param [String] name
1301
+ # Required. The resource name of the Control to delete. Format: `projects/`
1302
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
1303
+ # `data_store_id`/controls/`control_id``
1304
+ # @param [String] fields
1305
+ # Selector specifying which fields to include in a partial response.
1306
+ # @param [String] quota_user
1307
+ # Available to use for quota purposes for server-side applications. Can be any
1308
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1309
+ # @param [Google::Apis::RequestOptions] options
1310
+ # Request-specific options
1311
+ #
1312
+ # @yield [result, err] Result & error if block supplied
1313
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
1314
+ # @yieldparam err [StandardError] error object if request failed
1315
+ #
1316
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
1317
+ #
1318
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1319
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1320
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1321
+ def delete_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
1322
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1323
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
1324
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
1325
+ command.params['name'] = name unless name.nil?
1326
+ command.query['fields'] = fields unless fields.nil?
1327
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1328
+ execute_or_queue_command(command, &block)
1329
+ end
1330
+
1331
+ # Gets a Control.
1332
+ # @param [String] name
1333
+ # Required. The resource name of the Control to get. Format: `projects/`
1334
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
1335
+ # `data_store_id`/controls/`control_id``
1336
+ # @param [String] fields
1337
+ # Selector specifying which fields to include in a partial response.
1338
+ # @param [String] quota_user
1339
+ # Available to use for quota purposes for server-side applications. Can be any
1340
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1341
+ # @param [Google::Apis::RequestOptions] options
1342
+ # Request-specific options
1343
+ #
1344
+ # @yield [result, err] Result & error if block supplied
1345
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
1346
+ # @yieldparam err [StandardError] error object if request failed
1347
+ #
1348
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
1349
+ #
1350
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1351
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1352
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1353
+ def get_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
1354
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1355
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
1356
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
1357
+ command.params['name'] = name unless name.nil?
1358
+ command.query['fields'] = fields unless fields.nil?
1359
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1360
+ execute_or_queue_command(command, &block)
1361
+ end
1362
+
1363
+ # Lists all Controls by their parent DataStore.
1364
+ # @param [String] parent
1365
+ # Required. The data store resource name. Format: `projects/`project_number`/
1366
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
1367
+ # or `projects/`project_number`/locations/`location_id`/collections/`
1368
+ # collection_id`/engines/`engine_id``.
1369
+ # @param [String] filter
1370
+ # Optional. A filter to apply on the list results. Supported features: * List
1371
+ # all the products under the parent branch if filter is unset. Currently this
1372
+ # field is unsupported.
1373
+ # @param [Fixnum] page_size
1374
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
1375
+ # Max allowed value is 1000.
1376
+ # @param [String] page_token
1377
+ # Optional. A page token, received from a previous `ListControls` call. Provide
1378
+ # this to retrieve the subsequent page.
1379
+ # @param [String] fields
1380
+ # Selector specifying which fields to include in a partial response.
1381
+ # @param [String] quota_user
1382
+ # Available to use for quota purposes for server-side applications. Can be any
1383
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1384
+ # @param [Google::Apis::RequestOptions] options
1385
+ # Request-specific options
1386
+ #
1387
+ # @yield [result, err] Result & error if block supplied
1388
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse] parsed result object
1389
+ # @yieldparam err [StandardError] error object if request failed
1390
+ #
1391
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse]
1392
+ #
1393
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1394
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1395
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1396
+ 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)
1397
+ command = make_simple_command(:get, 'v1alpha/{+parent}/controls', options)
1398
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse::Representation
1399
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse
1400
+ command.params['parent'] = parent unless parent.nil?
1401
+ command.query['filter'] = filter unless filter.nil?
1402
+ command.query['pageSize'] = page_size unless page_size.nil?
1403
+ command.query['pageToken'] = page_token unless page_token.nil?
1404
+ command.query['fields'] = fields unless fields.nil?
1405
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1406
+ execute_or_queue_command(command, &block)
1407
+ end
1408
+
1409
+ # Updates a Control. Control action type cannot be changed. If the Control to
1410
+ # update does not exist, a NOT_FOUND error is returned.
1411
+ # @param [String] name
1412
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
1413
+ # controls/*`
1414
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
1415
+ # @param [String] update_mask
1416
+ # Optional. Indicates which fields in the provided Control to update. The
1417
+ # following are NOT supported: * Control.name * Control.solution_type If not set
1418
+ # or empty, all supported fields are updated.
1419
+ # @param [String] fields
1420
+ # Selector specifying which fields to include in a partial response.
1421
+ # @param [String] quota_user
1422
+ # Available to use for quota purposes for server-side applications. Can be any
1423
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1424
+ # @param [Google::Apis::RequestOptions] options
1425
+ # Request-specific options
1426
+ #
1427
+ # @yield [result, err] Result & error if block supplied
1428
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
1429
+ # @yieldparam err [StandardError] error object if request failed
1430
+ #
1431
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
1432
+ #
1433
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1434
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1435
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1436
+ 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)
1437
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1438
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
1439
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
1440
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
1441
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
1442
+ command.params['name'] = name unless name.nil?
1443
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1444
+ command.query['fields'] = fields unless fields.nil?
1445
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1446
+ execute_or_queue_command(command, &block)
1447
+ end
1448
+
1255
1449
  # Converses a conversation.
1256
1450
  # @param [String] name
1257
1451
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -3110,6 +3304,9 @@ module Google
3110
3304
  # across multiple DataStore, the format is: `projects/`project`/locations/`
3111
3305
  # location``.
3112
3306
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
3307
+ # @param [Boolean] write_async
3308
+ # If set to true, the user event is written asynchronously after validation, and
3309
+ # the API responds without waiting for the write.
3113
3310
  # @param [String] fields
3114
3311
  # Selector specifying which fields to include in a partial response.
3115
3312
  # @param [String] quota_user
@@ -3127,13 +3324,14 @@ module Google
3127
3324
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3128
3325
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3129
3326
  # @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)
3327
+ 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
3328
  command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
3132
3329
  command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
3133
3330
  command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
3134
3331
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
3135
3332
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
3136
3333
  command.params['parent'] = parent unless parent.nil?
3334
+ command.query['writeAsync'] = write_async unless write_async.nil?
3137
3335
  command.query['fields'] = fields unless fields.nil?
3138
3336
  command.query['quotaUser'] = quota_user unless quota_user.nil?
3139
3337
  execute_or_queue_command(command, &block)
@@ -3432,6 +3630,200 @@ module Google
3432
3630
  execute_or_queue_command(command, &block)
3433
3631
  end
3434
3632
 
3633
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
3634
+ # request can be submitted to adjust this limit. If the Control to create
3635
+ # already exists, an ALREADY_EXISTS error is returned.
3636
+ # @param [String] parent
3637
+ # Required. Full resource name of parent data store. Format: `projects/`
3638
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3639
+ # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
3640
+ # collections/`collection_id`/engines/`engine_id``.
3641
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
3642
+ # @param [String] control_id
3643
+ # Required. The ID to use for the Control, which will become the final component
3644
+ # of the Control's resource name. This value must be within 1-63 characters.
3645
+ # Valid characters are /a-z-_/.
3646
+ # @param [String] fields
3647
+ # Selector specifying which fields to include in a partial response.
3648
+ # @param [String] quota_user
3649
+ # Available to use for quota purposes for server-side applications. Can be any
3650
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3651
+ # @param [Google::Apis::RequestOptions] options
3652
+ # Request-specific options
3653
+ #
3654
+ # @yield [result, err] Result & error if block supplied
3655
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
3656
+ # @yieldparam err [StandardError] error object if request failed
3657
+ #
3658
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
3659
+ #
3660
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3661
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3662
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3663
+ 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)
3664
+ command = make_simple_command(:post, 'v1alpha/{+parent}/controls', options)
3665
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
3666
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
3667
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
3668
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
3669
+ command.params['parent'] = parent unless parent.nil?
3670
+ command.query['controlId'] = control_id unless control_id.nil?
3671
+ command.query['fields'] = fields unless fields.nil?
3672
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3673
+ execute_or_queue_command(command, &block)
3674
+ end
3675
+
3676
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
3677
+ # is returned.
3678
+ # @param [String] name
3679
+ # Required. The resource name of the Control to delete. Format: `projects/`
3680
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3681
+ # `data_store_id`/controls/`control_id``
3682
+ # @param [String] fields
3683
+ # Selector specifying which fields to include in a partial response.
3684
+ # @param [String] quota_user
3685
+ # Available to use for quota purposes for server-side applications. Can be any
3686
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3687
+ # @param [Google::Apis::RequestOptions] options
3688
+ # Request-specific options
3689
+ #
3690
+ # @yield [result, err] Result & error if block supplied
3691
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
3692
+ # @yieldparam err [StandardError] error object if request failed
3693
+ #
3694
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
3695
+ #
3696
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3697
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3698
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3699
+ def delete_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
3700
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
3701
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
3702
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
3703
+ command.params['name'] = name unless name.nil?
3704
+ command.query['fields'] = fields unless fields.nil?
3705
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3706
+ execute_or_queue_command(command, &block)
3707
+ end
3708
+
3709
+ # Gets a Control.
3710
+ # @param [String] name
3711
+ # Required. The resource name of the Control to get. Format: `projects/`
3712
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3713
+ # `data_store_id`/controls/`control_id``
3714
+ # @param [String] fields
3715
+ # Selector specifying which fields to include in a partial response.
3716
+ # @param [String] quota_user
3717
+ # Available to use for quota purposes for server-side applications. Can be any
3718
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3719
+ # @param [Google::Apis::RequestOptions] options
3720
+ # Request-specific options
3721
+ #
3722
+ # @yield [result, err] Result & error if block supplied
3723
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
3724
+ # @yieldparam err [StandardError] error object if request failed
3725
+ #
3726
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
3727
+ #
3728
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3729
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3730
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3731
+ def get_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
3732
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
3733
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
3734
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
3735
+ command.params['name'] = name unless name.nil?
3736
+ command.query['fields'] = fields unless fields.nil?
3737
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3738
+ execute_or_queue_command(command, &block)
3739
+ end
3740
+
3741
+ # Lists all Controls by their parent DataStore.
3742
+ # @param [String] parent
3743
+ # Required. The data store resource name. Format: `projects/`project_number`/
3744
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
3745
+ # or `projects/`project_number`/locations/`location_id`/collections/`
3746
+ # collection_id`/engines/`engine_id``.
3747
+ # @param [String] filter
3748
+ # Optional. A filter to apply on the list results. Supported features: * List
3749
+ # all the products under the parent branch if filter is unset. Currently this
3750
+ # field is unsupported.
3751
+ # @param [Fixnum] page_size
3752
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
3753
+ # Max allowed value is 1000.
3754
+ # @param [String] page_token
3755
+ # Optional. A page token, received from a previous `ListControls` call. Provide
3756
+ # this to retrieve the subsequent page.
3757
+ # @param [String] fields
3758
+ # Selector specifying which fields to include in a partial response.
3759
+ # @param [String] quota_user
3760
+ # Available to use for quota purposes for server-side applications. Can be any
3761
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3762
+ # @param [Google::Apis::RequestOptions] options
3763
+ # Request-specific options
3764
+ #
3765
+ # @yield [result, err] Result & error if block supplied
3766
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse] parsed result object
3767
+ # @yieldparam err [StandardError] error object if request failed
3768
+ #
3769
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse]
3770
+ #
3771
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3772
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3773
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3774
+ def list_project_location_collection_engine_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3775
+ command = make_simple_command(:get, 'v1alpha/{+parent}/controls', options)
3776
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse::Representation
3777
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse
3778
+ command.params['parent'] = parent unless parent.nil?
3779
+ command.query['filter'] = filter unless filter.nil?
3780
+ command.query['pageSize'] = page_size unless page_size.nil?
3781
+ command.query['pageToken'] = page_token unless page_token.nil?
3782
+ command.query['fields'] = fields unless fields.nil?
3783
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3784
+ execute_or_queue_command(command, &block)
3785
+ end
3786
+
3787
+ # Updates a Control. Control action type cannot be changed. If the Control to
3788
+ # update does not exist, a NOT_FOUND error is returned.
3789
+ # @param [String] name
3790
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
3791
+ # controls/*`
3792
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
3793
+ # @param [String] update_mask
3794
+ # Optional. Indicates which fields in the provided Control to update. The
3795
+ # following are NOT supported: * Control.name * Control.solution_type If not set
3796
+ # or empty, all supported fields are updated.
3797
+ # @param [String] fields
3798
+ # Selector specifying which fields to include in a partial response.
3799
+ # @param [String] quota_user
3800
+ # Available to use for quota purposes for server-side applications. Can be any
3801
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3802
+ # @param [Google::Apis::RequestOptions] options
3803
+ # Request-specific options
3804
+ #
3805
+ # @yield [result, err] Result & error if block supplied
3806
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
3807
+ # @yieldparam err [StandardError] error object if request failed
3808
+ #
3809
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
3810
+ #
3811
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3812
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3813
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3814
+ 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)
3815
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
3816
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
3817
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
3818
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
3819
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
3820
+ command.params['name'] = name unless name.nil?
3821
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3822
+ command.query['fields'] = fields unless fields.nil?
3823
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3824
+ execute_or_queue_command(command, &block)
3825
+ end
3826
+
3435
3827
  # Converses a conversation.
3436
3828
  # @param [String] name
3437
3829
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -4504,8 +4896,8 @@ module Google
4504
4896
  # permission to list DataStores under this location, regardless of whether or
4505
4897
  # not this data store exists, a PERMISSION_DENIED error is returned.
4506
4898
  # @param [String] filter
4507
- # Filter by solution type . For example: filter = 'solution_type:
4508
- # SOLUTION_TYPE_SEARCH'
4899
+ # Filter by solution type . For example: `filter = 'solution_type:
4900
+ # SOLUTION_TYPE_SEARCH'`
4509
4901
  # @param [Fixnum] page_size
4510
4902
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
4511
4903
  # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
@@ -5140,6 +5532,200 @@ module Google
5140
5532
  execute_or_queue_command(command, &block)
5141
5533
  end
5142
5534
 
5535
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
5536
+ # request can be submitted to adjust this limit. If the Control to create
5537
+ # already exists, an ALREADY_EXISTS error is returned.
5538
+ # @param [String] parent
5539
+ # Required. Full resource name of parent data store. Format: `projects/`
5540
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
5541
+ # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
5542
+ # collections/`collection_id`/engines/`engine_id``.
5543
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
5544
+ # @param [String] control_id
5545
+ # Required. The ID to use for the Control, which will become the final component
5546
+ # of the Control's resource name. This value must be within 1-63 characters.
5547
+ # Valid characters are /a-z-_/.
5548
+ # @param [String] fields
5549
+ # Selector specifying which fields to include in a partial response.
5550
+ # @param [String] quota_user
5551
+ # Available to use for quota purposes for server-side applications. Can be any
5552
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5553
+ # @param [Google::Apis::RequestOptions] options
5554
+ # Request-specific options
5555
+ #
5556
+ # @yield [result, err] Result & error if block supplied
5557
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
5558
+ # @yieldparam err [StandardError] error object if request failed
5559
+ #
5560
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
5561
+ #
5562
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5563
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5564
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5565
+ 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)
5566
+ command = make_simple_command(:post, 'v1alpha/{+parent}/controls', options)
5567
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
5568
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
5569
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
5570
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
5571
+ command.params['parent'] = parent unless parent.nil?
5572
+ command.query['controlId'] = control_id unless control_id.nil?
5573
+ command.query['fields'] = fields unless fields.nil?
5574
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5575
+ execute_or_queue_command(command, &block)
5576
+ end
5577
+
5578
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
5579
+ # is returned.
5580
+ # @param [String] name
5581
+ # Required. The resource name of the Control to delete. Format: `projects/`
5582
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
5583
+ # `data_store_id`/controls/`control_id``
5584
+ # @param [String] fields
5585
+ # Selector specifying which fields to include in a partial response.
5586
+ # @param [String] quota_user
5587
+ # Available to use for quota purposes for server-side applications. Can be any
5588
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5589
+ # @param [Google::Apis::RequestOptions] options
5590
+ # Request-specific options
5591
+ #
5592
+ # @yield [result, err] Result & error if block supplied
5593
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
5594
+ # @yieldparam err [StandardError] error object if request failed
5595
+ #
5596
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
5597
+ #
5598
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5599
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5600
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5601
+ def delete_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
5602
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
5603
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
5604
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
5605
+ command.params['name'] = name unless name.nil?
5606
+ command.query['fields'] = fields unless fields.nil?
5607
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5608
+ execute_or_queue_command(command, &block)
5609
+ end
5610
+
5611
+ # Gets a Control.
5612
+ # @param [String] name
5613
+ # Required. The resource name of the Control to get. Format: `projects/`
5614
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
5615
+ # `data_store_id`/controls/`control_id``
5616
+ # @param [String] fields
5617
+ # Selector specifying which fields to include in a partial response.
5618
+ # @param [String] quota_user
5619
+ # Available to use for quota purposes for server-side applications. Can be any
5620
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5621
+ # @param [Google::Apis::RequestOptions] options
5622
+ # Request-specific options
5623
+ #
5624
+ # @yield [result, err] Result & error if block supplied
5625
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
5626
+ # @yieldparam err [StandardError] error object if request failed
5627
+ #
5628
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
5629
+ #
5630
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5631
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5632
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5633
+ def get_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
5634
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
5635
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
5636
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
5637
+ command.params['name'] = name unless name.nil?
5638
+ command.query['fields'] = fields unless fields.nil?
5639
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5640
+ execute_or_queue_command(command, &block)
5641
+ end
5642
+
5643
+ # Lists all Controls by their parent DataStore.
5644
+ # @param [String] parent
5645
+ # Required. The data store resource name. Format: `projects/`project_number`/
5646
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
5647
+ # or `projects/`project_number`/locations/`location_id`/collections/`
5648
+ # collection_id`/engines/`engine_id``.
5649
+ # @param [String] filter
5650
+ # Optional. A filter to apply on the list results. Supported features: * List
5651
+ # all the products under the parent branch if filter is unset. Currently this
5652
+ # field is unsupported.
5653
+ # @param [Fixnum] page_size
5654
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
5655
+ # Max allowed value is 1000.
5656
+ # @param [String] page_token
5657
+ # Optional. A page token, received from a previous `ListControls` call. Provide
5658
+ # this to retrieve the subsequent page.
5659
+ # @param [String] fields
5660
+ # Selector specifying which fields to include in a partial response.
5661
+ # @param [String] quota_user
5662
+ # Available to use for quota purposes for server-side applications. Can be any
5663
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5664
+ # @param [Google::Apis::RequestOptions] options
5665
+ # Request-specific options
5666
+ #
5667
+ # @yield [result, err] Result & error if block supplied
5668
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse] parsed result object
5669
+ # @yieldparam err [StandardError] error object if request failed
5670
+ #
5671
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse]
5672
+ #
5673
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5674
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5675
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5676
+ def list_project_location_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
5677
+ command = make_simple_command(:get, 'v1alpha/{+parent}/controls', options)
5678
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse::Representation
5679
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListControlsResponse
5680
+ command.params['parent'] = parent unless parent.nil?
5681
+ command.query['filter'] = filter unless filter.nil?
5682
+ command.query['pageSize'] = page_size unless page_size.nil?
5683
+ command.query['pageToken'] = page_token unless page_token.nil?
5684
+ command.query['fields'] = fields unless fields.nil?
5685
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5686
+ execute_or_queue_command(command, &block)
5687
+ end
5688
+
5689
+ # Updates a Control. Control action type cannot be changed. If the Control to
5690
+ # update does not exist, a NOT_FOUND error is returned.
5691
+ # @param [String] name
5692
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
5693
+ # controls/*`
5694
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
5695
+ # @param [String] update_mask
5696
+ # Optional. Indicates which fields in the provided Control to update. The
5697
+ # following are NOT supported: * Control.name * Control.solution_type If not set
5698
+ # or empty, all supported fields are updated.
5699
+ # @param [String] fields
5700
+ # Selector specifying which fields to include in a partial response.
5701
+ # @param [String] quota_user
5702
+ # Available to use for quota purposes for server-side applications. Can be any
5703
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5704
+ # @param [Google::Apis::RequestOptions] options
5705
+ # Request-specific options
5706
+ #
5707
+ # @yield [result, err] Result & error if block supplied
5708
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] parsed result object
5709
+ # @yieldparam err [StandardError] error object if request failed
5710
+ #
5711
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl]
5712
+ #
5713
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5714
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5715
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5716
+ 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)
5717
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
5718
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
5719
+ command.request_object = google_cloud_discoveryengine_v1alpha_control_object
5720
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl::Representation
5721
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl
5722
+ command.params['name'] = name unless name.nil?
5723
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5724
+ command.query['fields'] = fields unless fields.nil?
5725
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5726
+ execute_or_queue_command(command, &block)
5727
+ end
5728
+
5143
5729
  # Converses a conversation.
5144
5730
  # @param [String] name
5145
5731
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -6672,6 +7258,9 @@ module Google
6672
7258
  # across multiple DataStore, the format is: `projects/`project`/locations/`
6673
7259
  # location``.
6674
7260
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
7261
+ # @param [Boolean] write_async
7262
+ # If set to true, the user event is written asynchronously after validation, and
7263
+ # the API responds without waiting for the write.
6675
7264
  # @param [String] fields
6676
7265
  # Selector specifying which fields to include in a partial response.
6677
7266
  # @param [String] quota_user
@@ -6689,13 +7278,14 @@ module Google
6689
7278
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6690
7279
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6691
7280
  # @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)
7281
+ 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
7282
  command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
6694
7283
  command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6695
7284
  command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
6696
7285
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6697
7286
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
6698
7287
  command.params['parent'] = parent unless parent.nil?
7288
+ command.query['writeAsync'] = write_async unless write_async.nil?
6699
7289
  command.query['fields'] = fields unless fields.nil?
6700
7290
  command.query['quotaUser'] = quota_user unless quota_user.nil?
6701
7291
  execute_or_queue_command(command, &block)
@@ -6871,6 +7461,40 @@ module Google
6871
7461
  execute_or_queue_command(command, &block)
6872
7462
  end
6873
7463
 
7464
+ # Check a particular requirement.
7465
+ # @param [String] location
7466
+ # Required. Full resource name of the location. Format `projects/`
7467
+ # project_number_or_id`/locations/`location``
7468
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest] google_cloud_discoveryengine_v1alpha_check_requirement_request_object
7469
+ # @param [String] fields
7470
+ # Selector specifying which fields to include in a partial response.
7471
+ # @param [String] quota_user
7472
+ # Available to use for quota purposes for server-side applications. Can be any
7473
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7474
+ # @param [Google::Apis::RequestOptions] options
7475
+ # Request-specific options
7476
+ #
7477
+ # @yield [result, err] Result & error if block supplied
7478
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse] parsed result object
7479
+ # @yieldparam err [StandardError] error object if request failed
7480
+ #
7481
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse]
7482
+ #
7483
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7484
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7485
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7486
+ def check_project_location_requirement_requirement(location, google_cloud_discoveryengine_v1alpha_check_requirement_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7487
+ command = make_simple_command(:post, 'v1alpha/{+location}/requirements:checkRequirement', options)
7488
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest::Representation
7489
+ command.request_object = google_cloud_discoveryengine_v1alpha_check_requirement_request_object
7490
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse::Representation
7491
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse
7492
+ command.params['location'] = location unless location.nil?
7493
+ command.query['fields'] = fields unless fields.nil?
7494
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7495
+ execute_or_queue_command(command, &block)
7496
+ end
7497
+
6874
7498
  # Gets the latest state of a long-running operation. Clients can use this method
6875
7499
  # to poll the operation result at intervals as recommended by the API service.
6876
7500
  # @param [String] name
@@ -6902,6 +7526,54 @@ module Google
6902
7526
  execute_or_queue_command(command, &block)
6903
7527
  end
6904
7528
 
7529
+ # Writes a single user event from the browser. This uses a GET request to due to
7530
+ # browser restriction of POST-ing to a third-party domain. This method is used
7531
+ # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
7532
+ # Users should not call this method directly.
7533
+ # @param [String] parent
7534
+ # Required. The parent DataStore resource name, such as `projects/`project`/
7535
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
7536
+ # @param [Fixnum] ets
7537
+ # The event timestamp in milliseconds. This prevents browser caching of
7538
+ # otherwise identical get requests. The name is abbreviated to reduce the
7539
+ # payload bytes.
7540
+ # @param [String] uri
7541
+ # The URL including cgi-parameters but excluding the hash fragment with a length
7542
+ # limit of 5,000 characters. This is often more useful than the referer URL,
7543
+ # because many browsers only send the domain for third-party requests.
7544
+ # @param [String] user_event
7545
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
7546
+ # characters.
7547
+ # @param [String] fields
7548
+ # Selector specifying which fields to include in a partial response.
7549
+ # @param [String] quota_user
7550
+ # Available to use for quota purposes for server-side applications. Can be any
7551
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7552
+ # @param [Google::Apis::RequestOptions] options
7553
+ # Request-specific options
7554
+ #
7555
+ # @yield [result, err] Result & error if block supplied
7556
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody] parsed result object
7557
+ # @yieldparam err [StandardError] error object if request failed
7558
+ #
7559
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody]
7560
+ #
7561
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7562
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7563
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7564
+ def collect_project_location_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
7565
+ command = make_simple_command(:get, 'v1alpha/{+parent}/userEvents:collect', options)
7566
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody::Representation
7567
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody
7568
+ command.params['parent'] = parent unless parent.nil?
7569
+ command.query['ets'] = ets unless ets.nil?
7570
+ command.query['uri'] = uri unless uri.nil?
7571
+ command.query['userEvent'] = user_event unless user_event.nil?
7572
+ command.query['fields'] = fields unless fields.nil?
7573
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7574
+ execute_or_queue_command(command, &block)
7575
+ end
7576
+
6905
7577
  # Writes a single user event.
6906
7578
  # @param [String] parent
6907
7579
  # Required. The parent resource name. If the write user event action is applied
@@ -6911,6 +7583,9 @@ module Google
6911
7583
  # across multiple DataStore, the format is: `projects/`project`/locations/`
6912
7584
  # location``.
6913
7585
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
7586
+ # @param [Boolean] write_async
7587
+ # If set to true, the user event is written asynchronously after validation, and
7588
+ # the API responds without waiting for the write.
6914
7589
  # @param [String] fields
6915
7590
  # Selector specifying which fields to include in a partial response.
6916
7591
  # @param [String] quota_user
@@ -6928,13 +7603,14 @@ module Google
6928
7603
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6929
7604
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6930
7605
  # @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)
7606
+ 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
7607
  command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
6933
7608
  command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6934
7609
  command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
6935
7610
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
6936
7611
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
6937
7612
  command.params['parent'] = parent unless parent.nil?
7613
+ command.query['writeAsync'] = write_async unless write_async.nil?
6938
7614
  command.query['fields'] = fields unless fields.nil?
6939
7615
  command.query['quotaUser'] = quota_user unless quota_user.nil?
6940
7616
  execute_or_queue_command(command, &block)