google-apis-discoveryengine_v1 0.56.0 → 0.58.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -710,9 +710,9 @@ module Google
710
710
  # values: * `document` is the default model for regular dataStores. * `search-
711
711
  # history` is the default model for site search dataStores.
712
712
  # @param [String] user_pseudo_id
713
- # A unique identifier for tracking visitors. For example, this could be
714
- # implemented with an HTTP cookie, which should be able to uniquely identify a
715
- # visitor on a single device. This unique identifier should not change if the
713
+ # Optional. A unique identifier for tracking visitors. For example, this could
714
+ # be implemented with an HTTP cookie, which should be able to uniquely identify
715
+ # a visitor on a single device. This unique identifier should not change if the
716
716
  # visitor logs in or out of the website. This field should NOT have a fixed
717
717
  # value such as `unknown_visitor`. This should be the same identifier as
718
718
  # UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
@@ -2496,6 +2496,78 @@ module Google
2496
2496
  execute_or_queue_command(command, &block)
2497
2497
  end
2498
2498
 
2499
+ # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
2500
+ # exist.
2501
+ # @param [String] name
2502
+ # Required. The resource name of the ServingConfig to get. Format: `projects/`
2503
+ # project`/locations/`location`/collections/`collection`/engines/`engine`/
2504
+ # servingConfigs/`serving_config_id``
2505
+ # @param [String] fields
2506
+ # Selector specifying which fields to include in a partial response.
2507
+ # @param [String] quota_user
2508
+ # Available to use for quota purposes for server-side applications. Can be any
2509
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2510
+ # @param [Google::Apis::RequestOptions] options
2511
+ # Request-specific options
2512
+ #
2513
+ # @yield [result, err] Result & error if block supplied
2514
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig] parsed result object
2515
+ # @yieldparam err [StandardError] error object if request failed
2516
+ #
2517
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig]
2518
+ #
2519
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2520
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2521
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2522
+ def get_project_location_collection_data_store_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
2523
+ command = make_simple_command(:get, 'v1/{+name}', options)
2524
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig::Representation
2525
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig
2526
+ command.params['name'] = name unless name.nil?
2527
+ command.query['fields'] = fields unless fields.nil?
2528
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2529
+ execute_or_queue_command(command, &block)
2530
+ end
2531
+
2532
+ # Lists all ServingConfigs linked to this dataStore.
2533
+ # @param [String] parent
2534
+ # Required. Full resource name of the parent resource. Format: `projects/`
2535
+ # project`/locations/`location`/collections/`collection`/engines/`engine``
2536
+ # @param [Fixnum] page_size
2537
+ # Optional. Maximum number of results to return. If unspecified, defaults to 100.
2538
+ # If a value greater than 100 is provided, at most 100 results are returned.
2539
+ # @param [String] page_token
2540
+ # Optional. A page token, received from a previous `ListServingConfigs` call.
2541
+ # Provide this to retrieve the subsequent page.
2542
+ # @param [String] fields
2543
+ # Selector specifying which fields to include in a partial response.
2544
+ # @param [String] quota_user
2545
+ # Available to use for quota purposes for server-side applications. Can be any
2546
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2547
+ # @param [Google::Apis::RequestOptions] options
2548
+ # Request-specific options
2549
+ #
2550
+ # @yield [result, err] Result & error if block supplied
2551
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse] parsed result object
2552
+ # @yieldparam err [StandardError] error object if request failed
2553
+ #
2554
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse]
2555
+ #
2556
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2557
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2558
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2559
+ def list_project_location_collection_data_store_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2560
+ command = make_simple_command(:get, 'v1/{+parent}/servingConfigs', options)
2561
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse::Representation
2562
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse
2563
+ command.params['parent'] = parent unless parent.nil?
2564
+ command.query['pageSize'] = page_size unless page_size.nil?
2565
+ command.query['pageToken'] = page_token unless page_token.nil?
2566
+ command.query['fields'] = fields unless fields.nil?
2567
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2568
+ execute_or_queue_command(command, &block)
2569
+ end
2570
+
2499
2571
  # Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
2500
2572
  # not exist.
2501
2573
  # @param [String] name
@@ -3833,6 +3905,90 @@ module Google
3833
3905
  execute_or_queue_command(command, &block)
3834
3906
  end
3835
3907
 
3908
+ # Gets a WidgetConfig.
3909
+ # @param [String] name
3910
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
3911
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
3912
+ # widgetConfigs/`widget_config_id``
3913
+ # @param [Boolean] accept_cache
3914
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
3915
+ # to true, recent changes on widget configs may take a few minutes to reflect on
3916
+ # the end user's view. It's recommended to set to true for maturely developed
3917
+ # widgets, as it improves widget performance. Set to false to see changes
3918
+ # reflected in prod right away, if your widget is under development.
3919
+ # @param [Boolean] get_widget_config_request_option_turn_off_collection_components
3920
+ # Optional. Whether to turn off collection_components in WidgetConfig to reduce
3921
+ # latency and data transmission.
3922
+ # @param [String] fields
3923
+ # Selector specifying which fields to include in a partial response.
3924
+ # @param [String] quota_user
3925
+ # Available to use for quota purposes for server-side applications. Can be any
3926
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3927
+ # @param [Google::Apis::RequestOptions] options
3928
+ # Request-specific options
3929
+ #
3930
+ # @yield [result, err] Result & error if block supplied
3931
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
3932
+ # @yieldparam err [StandardError] error object if request failed
3933
+ #
3934
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
3935
+ #
3936
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3937
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3938
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3939
+ def get_project_location_collection_data_store_widget_config(name, accept_cache: nil, get_widget_config_request_option_turn_off_collection_components: nil, fields: nil, quota_user: nil, options: nil, &block)
3940
+ command = make_simple_command(:get, 'v1/{+name}', options)
3941
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
3942
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
3943
+ command.params['name'] = name unless name.nil?
3944
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
3945
+ command.query['getWidgetConfigRequestOption.turnOffCollectionComponents'] = get_widget_config_request_option_turn_off_collection_components unless get_widget_config_request_option_turn_off_collection_components.nil?
3946
+ command.query['fields'] = fields unless fields.nil?
3947
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3948
+ execute_or_queue_command(command, &block)
3949
+ end
3950
+
3951
+ # Update a WidgetConfig.
3952
+ # @param [String] name
3953
+ # Immutable. The full resource name of the widget config. Format: `projects/`
3954
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
3955
+ # data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
3956
+ # encoded string with a length limit of 1024 characters.
3957
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] google_cloud_discoveryengine_v1_widget_config_object
3958
+ # @param [String] update_mask
3959
+ # Indicates which fields in the provided WidgetConfig to update. The following
3960
+ # are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
3961
+ # all supported fields are updated.
3962
+ # @param [String] fields
3963
+ # Selector specifying which fields to include in a partial response.
3964
+ # @param [String] quota_user
3965
+ # Available to use for quota purposes for server-side applications. Can be any
3966
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3967
+ # @param [Google::Apis::RequestOptions] options
3968
+ # Request-specific options
3969
+ #
3970
+ # @yield [result, err] Result & error if block supplied
3971
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
3972
+ # @yieldparam err [StandardError] error object if request failed
3973
+ #
3974
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
3975
+ #
3976
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3977
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3978
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3979
+ def patch_project_location_collection_data_store_widget_config(name, google_cloud_discoveryengine_v1_widget_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3980
+ command = make_simple_command(:patch, 'v1/{+name}', options)
3981
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
3982
+ command.request_object = google_cloud_discoveryengine_v1_widget_config_object
3983
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
3984
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
3985
+ command.params['name'] = name unless name.nil?
3986
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3987
+ command.query['fields'] = fields unless fields.nil?
3988
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3989
+ execute_or_queue_command(command, &block)
3990
+ end
3991
+
3836
3992
  # Creates a Engine.
3837
3993
  # @param [String] parent
3838
3994
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -4739,6 +4895,78 @@ module Google
4739
4895
  execute_or_queue_command(command, &block)
4740
4896
  end
4741
4897
 
4898
+ # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
4899
+ # exist.
4900
+ # @param [String] name
4901
+ # Required. The resource name of the ServingConfig to get. Format: `projects/`
4902
+ # project`/locations/`location`/collections/`collection`/engines/`engine`/
4903
+ # servingConfigs/`serving_config_id``
4904
+ # @param [String] fields
4905
+ # Selector specifying which fields to include in a partial response.
4906
+ # @param [String] quota_user
4907
+ # Available to use for quota purposes for server-side applications. Can be any
4908
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4909
+ # @param [Google::Apis::RequestOptions] options
4910
+ # Request-specific options
4911
+ #
4912
+ # @yield [result, err] Result & error if block supplied
4913
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig] parsed result object
4914
+ # @yieldparam err [StandardError] error object if request failed
4915
+ #
4916
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig]
4917
+ #
4918
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4919
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4920
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4921
+ def get_project_location_collection_engine_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
4922
+ command = make_simple_command(:get, 'v1/{+name}', options)
4923
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig::Representation
4924
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig
4925
+ command.params['name'] = name unless name.nil?
4926
+ command.query['fields'] = fields unless fields.nil?
4927
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4928
+ execute_or_queue_command(command, &block)
4929
+ end
4930
+
4931
+ # Lists all ServingConfigs linked to this dataStore.
4932
+ # @param [String] parent
4933
+ # Required. Full resource name of the parent resource. Format: `projects/`
4934
+ # project`/locations/`location`/collections/`collection`/engines/`engine``
4935
+ # @param [Fixnum] page_size
4936
+ # Optional. Maximum number of results to return. If unspecified, defaults to 100.
4937
+ # If a value greater than 100 is provided, at most 100 results are returned.
4938
+ # @param [String] page_token
4939
+ # Optional. A page token, received from a previous `ListServingConfigs` call.
4940
+ # Provide this to retrieve the subsequent page.
4941
+ # @param [String] fields
4942
+ # Selector specifying which fields to include in a partial response.
4943
+ # @param [String] quota_user
4944
+ # Available to use for quota purposes for server-side applications. Can be any
4945
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4946
+ # @param [Google::Apis::RequestOptions] options
4947
+ # Request-specific options
4948
+ #
4949
+ # @yield [result, err] Result & error if block supplied
4950
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse] parsed result object
4951
+ # @yieldparam err [StandardError] error object if request failed
4952
+ #
4953
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse]
4954
+ #
4955
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4956
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4957
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4958
+ def list_project_location_collection_engine_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4959
+ command = make_simple_command(:get, 'v1/{+parent}/servingConfigs', options)
4960
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse::Representation
4961
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse
4962
+ command.params['parent'] = parent unless parent.nil?
4963
+ command.query['pageSize'] = page_size unless page_size.nil?
4964
+ command.query['pageToken'] = page_token unless page_token.nil?
4965
+ command.query['fields'] = fields unless fields.nil?
4966
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4967
+ execute_or_queue_command(command, &block)
4968
+ end
4969
+
4742
4970
  # Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
4743
4971
  # not exist.
4744
4972
  # @param [String] name
@@ -5172,6 +5400,90 @@ module Google
5172
5400
  execute_or_queue_command(command, &block)
5173
5401
  end
5174
5402
 
5403
+ # Gets a WidgetConfig.
5404
+ # @param [String] name
5405
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
5406
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
5407
+ # widgetConfigs/`widget_config_id``
5408
+ # @param [Boolean] accept_cache
5409
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
5410
+ # to true, recent changes on widget configs may take a few minutes to reflect on
5411
+ # the end user's view. It's recommended to set to true for maturely developed
5412
+ # widgets, as it improves widget performance. Set to false to see changes
5413
+ # reflected in prod right away, if your widget is under development.
5414
+ # @param [Boolean] get_widget_config_request_option_turn_off_collection_components
5415
+ # Optional. Whether to turn off collection_components in WidgetConfig to reduce
5416
+ # latency and data transmission.
5417
+ # @param [String] fields
5418
+ # Selector specifying which fields to include in a partial response.
5419
+ # @param [String] quota_user
5420
+ # Available to use for quota purposes for server-side applications. Can be any
5421
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5422
+ # @param [Google::Apis::RequestOptions] options
5423
+ # Request-specific options
5424
+ #
5425
+ # @yield [result, err] Result & error if block supplied
5426
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
5427
+ # @yieldparam err [StandardError] error object if request failed
5428
+ #
5429
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
5430
+ #
5431
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5432
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5433
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5434
+ def get_project_location_collection_engine_widget_config(name, accept_cache: nil, get_widget_config_request_option_turn_off_collection_components: nil, fields: nil, quota_user: nil, options: nil, &block)
5435
+ command = make_simple_command(:get, 'v1/{+name}', options)
5436
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
5437
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
5438
+ command.params['name'] = name unless name.nil?
5439
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
5440
+ command.query['getWidgetConfigRequestOption.turnOffCollectionComponents'] = get_widget_config_request_option_turn_off_collection_components unless get_widget_config_request_option_turn_off_collection_components.nil?
5441
+ command.query['fields'] = fields unless fields.nil?
5442
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5443
+ execute_or_queue_command(command, &block)
5444
+ end
5445
+
5446
+ # Update a WidgetConfig.
5447
+ # @param [String] name
5448
+ # Immutable. The full resource name of the widget config. Format: `projects/`
5449
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
5450
+ # data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
5451
+ # encoded string with a length limit of 1024 characters.
5452
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] google_cloud_discoveryengine_v1_widget_config_object
5453
+ # @param [String] update_mask
5454
+ # Indicates which fields in the provided WidgetConfig to update. The following
5455
+ # are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
5456
+ # all supported fields are updated.
5457
+ # @param [String] fields
5458
+ # Selector specifying which fields to include in a partial response.
5459
+ # @param [String] quota_user
5460
+ # Available to use for quota purposes for server-side applications. Can be any
5461
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5462
+ # @param [Google::Apis::RequestOptions] options
5463
+ # Request-specific options
5464
+ #
5465
+ # @yield [result, err] Result & error if block supplied
5466
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
5467
+ # @yieldparam err [StandardError] error object if request failed
5468
+ #
5469
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
5470
+ #
5471
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5472
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5473
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5474
+ def patch_project_location_collection_engine_widget_config(name, google_cloud_discoveryengine_v1_widget_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
5475
+ command = make_simple_command(:patch, 'v1/{+name}', options)
5476
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
5477
+ command.request_object = google_cloud_discoveryengine_v1_widget_config_object
5478
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
5479
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
5480
+ command.params['name'] = name unless name.nil?
5481
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5482
+ command.query['fields'] = fields unless fields.nil?
5483
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5484
+ execute_or_queue_command(command, &block)
5485
+ end
5486
+
5175
5487
  # Gets the latest state of a long-running operation. Clients can use this method
5176
5488
  # to poll the operation result at intervals as recommended by the API service.
5177
5489
  # @param [String] name
@@ -5275,9 +5587,9 @@ module Google
5275
5587
  # values: * `document` is the default model for regular dataStores. * `search-
5276
5588
  # history` is the default model for site search dataStores.
5277
5589
  # @param [String] user_pseudo_id
5278
- # A unique identifier for tracking visitors. For example, this could be
5279
- # implemented with an HTTP cookie, which should be able to uniquely identify a
5280
- # visitor on a single device. This unique identifier should not change if the
5590
+ # Optional. A unique identifier for tracking visitors. For example, this could
5591
+ # be implemented with an HTTP cookie, which should be able to uniquely identify
5592
+ # a visitor on a single device. This unique identifier should not change if the
5281
5593
  # visitor logs in or out of the website. This field should NOT have a fixed
5282
5594
  # value such as `unknown_visitor`. This should be the same identifier as
5283
5595
  # UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
@@ -6915,6 +7227,78 @@ module Google
6915
7227
  execute_or_queue_command(command, &block)
6916
7228
  end
6917
7229
 
7230
+ # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
7231
+ # exist.
7232
+ # @param [String] name
7233
+ # Required. The resource name of the ServingConfig to get. Format: `projects/`
7234
+ # project`/locations/`location`/collections/`collection`/engines/`engine`/
7235
+ # servingConfigs/`serving_config_id``
7236
+ # @param [String] fields
7237
+ # Selector specifying which fields to include in a partial response.
7238
+ # @param [String] quota_user
7239
+ # Available to use for quota purposes for server-side applications. Can be any
7240
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7241
+ # @param [Google::Apis::RequestOptions] options
7242
+ # Request-specific options
7243
+ #
7244
+ # @yield [result, err] Result & error if block supplied
7245
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig] parsed result object
7246
+ # @yieldparam err [StandardError] error object if request failed
7247
+ #
7248
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig]
7249
+ #
7250
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7251
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7252
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7253
+ def get_project_location_data_store_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
7254
+ command = make_simple_command(:get, 'v1/{+name}', options)
7255
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig::Representation
7256
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig
7257
+ command.params['name'] = name unless name.nil?
7258
+ command.query['fields'] = fields unless fields.nil?
7259
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7260
+ execute_or_queue_command(command, &block)
7261
+ end
7262
+
7263
+ # Lists all ServingConfigs linked to this dataStore.
7264
+ # @param [String] parent
7265
+ # Required. Full resource name of the parent resource. Format: `projects/`
7266
+ # project`/locations/`location`/collections/`collection`/engines/`engine``
7267
+ # @param [Fixnum] page_size
7268
+ # Optional. Maximum number of results to return. If unspecified, defaults to 100.
7269
+ # If a value greater than 100 is provided, at most 100 results are returned.
7270
+ # @param [String] page_token
7271
+ # Optional. A page token, received from a previous `ListServingConfigs` call.
7272
+ # Provide this to retrieve the subsequent page.
7273
+ # @param [String] fields
7274
+ # Selector specifying which fields to include in a partial response.
7275
+ # @param [String] quota_user
7276
+ # Available to use for quota purposes for server-side applications. Can be any
7277
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7278
+ # @param [Google::Apis::RequestOptions] options
7279
+ # Request-specific options
7280
+ #
7281
+ # @yield [result, err] Result & error if block supplied
7282
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse] parsed result object
7283
+ # @yieldparam err [StandardError] error object if request failed
7284
+ #
7285
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse]
7286
+ #
7287
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7288
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7289
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7290
+ def list_project_location_data_store_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7291
+ command = make_simple_command(:get, 'v1/{+parent}/servingConfigs', options)
7292
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse::Representation
7293
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListServingConfigsResponse
7294
+ command.params['parent'] = parent unless parent.nil?
7295
+ command.query['pageSize'] = page_size unless page_size.nil?
7296
+ command.query['pageToken'] = page_token unless page_token.nil?
7297
+ command.query['fields'] = fields unless fields.nil?
7298
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7299
+ execute_or_queue_command(command, &block)
7300
+ end
7301
+
6918
7302
  # Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
6919
7303
  # not exist.
6920
7304
  # @param [String] name
@@ -8013,6 +8397,90 @@ module Google
8013
8397
  execute_or_queue_command(command, &block)
8014
8398
  end
8015
8399
 
8400
+ # Gets a WidgetConfig.
8401
+ # @param [String] name
8402
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
8403
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
8404
+ # widgetConfigs/`widget_config_id``
8405
+ # @param [Boolean] accept_cache
8406
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
8407
+ # to true, recent changes on widget configs may take a few minutes to reflect on
8408
+ # the end user's view. It's recommended to set to true for maturely developed
8409
+ # widgets, as it improves widget performance. Set to false to see changes
8410
+ # reflected in prod right away, if your widget is under development.
8411
+ # @param [Boolean] get_widget_config_request_option_turn_off_collection_components
8412
+ # Optional. Whether to turn off collection_components in WidgetConfig to reduce
8413
+ # latency and data transmission.
8414
+ # @param [String] fields
8415
+ # Selector specifying which fields to include in a partial response.
8416
+ # @param [String] quota_user
8417
+ # Available to use for quota purposes for server-side applications. Can be any
8418
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8419
+ # @param [Google::Apis::RequestOptions] options
8420
+ # Request-specific options
8421
+ #
8422
+ # @yield [result, err] Result & error if block supplied
8423
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
8424
+ # @yieldparam err [StandardError] error object if request failed
8425
+ #
8426
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
8427
+ #
8428
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8429
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8430
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8431
+ def get_project_location_data_store_widget_config(name, accept_cache: nil, get_widget_config_request_option_turn_off_collection_components: nil, fields: nil, quota_user: nil, options: nil, &block)
8432
+ command = make_simple_command(:get, 'v1/{+name}', options)
8433
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
8434
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
8435
+ command.params['name'] = name unless name.nil?
8436
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
8437
+ command.query['getWidgetConfigRequestOption.turnOffCollectionComponents'] = get_widget_config_request_option_turn_off_collection_components unless get_widget_config_request_option_turn_off_collection_components.nil?
8438
+ command.query['fields'] = fields unless fields.nil?
8439
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8440
+ execute_or_queue_command(command, &block)
8441
+ end
8442
+
8443
+ # Update a WidgetConfig.
8444
+ # @param [String] name
8445
+ # Immutable. The full resource name of the widget config. Format: `projects/`
8446
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
8447
+ # data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
8448
+ # encoded string with a length limit of 1024 characters.
8449
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] google_cloud_discoveryengine_v1_widget_config_object
8450
+ # @param [String] update_mask
8451
+ # Indicates which fields in the provided WidgetConfig to update. The following
8452
+ # are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
8453
+ # all supported fields are updated.
8454
+ # @param [String] fields
8455
+ # Selector specifying which fields to include in a partial response.
8456
+ # @param [String] quota_user
8457
+ # Available to use for quota purposes for server-side applications. Can be any
8458
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8459
+ # @param [Google::Apis::RequestOptions] options
8460
+ # Request-specific options
8461
+ #
8462
+ # @yield [result, err] Result & error if block supplied
8463
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
8464
+ # @yieldparam err [StandardError] error object if request failed
8465
+ #
8466
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
8467
+ #
8468
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8469
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8470
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8471
+ def patch_project_location_data_store_widget_config(name, google_cloud_discoveryengine_v1_widget_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
8472
+ command = make_simple_command(:patch, 'v1/{+name}', options)
8473
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
8474
+ command.request_object = google_cloud_discoveryengine_v1_widget_config_object
8475
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
8476
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
8477
+ command.params['name'] = name unless name.nil?
8478
+ command.query['updateMask'] = update_mask unless update_mask.nil?
8479
+ command.query['fields'] = fields unless fields.nil?
8480
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8481
+ execute_or_queue_command(command, &block)
8482
+ end
8483
+
8016
8484
  # Performs a grounding check.
8017
8485
  # @param [String] grounding_config
8018
8486
  # Required. The resource name of the grounding config, such as `projects/*/
@@ -8956,18 +9424,50 @@ module Google
8956
9424
  execute_or_queue_command(command, &block)
8957
9425
  end
8958
9426
 
9427
+ # Lists all the LicenseConfigUsageStatss associated with the project.
9428
+ # @param [String] parent
9429
+ # Required. The parent branch resource name, such as `projects/`project`/
9430
+ # locations/`location`/userStores/`user_store_id``.
9431
+ # @param [String] fields
9432
+ # Selector specifying which fields to include in a partial response.
9433
+ # @param [String] quota_user
9434
+ # Available to use for quota purposes for server-side applications. Can be any
9435
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9436
+ # @param [Google::Apis::RequestOptions] options
9437
+ # Request-specific options
9438
+ #
9439
+ # @yield [result, err] Result & error if block supplied
9440
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse] parsed result object
9441
+ # @yieldparam err [StandardError] error object if request failed
9442
+ #
9443
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse]
9444
+ #
9445
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9446
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9447
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9448
+ def list_project_location_user_store_license_configs_usage_stats(parent, fields: nil, quota_user: nil, options: nil, &block)
9449
+ command = make_simple_command(:get, 'v1/{+parent}/licenseConfigsUsageStats', options)
9450
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse::Representation
9451
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse
9452
+ command.params['parent'] = parent unless parent.nil?
9453
+ command.query['fields'] = fields unless fields.nil?
9454
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9455
+ execute_or_queue_command(command, &block)
9456
+ end
9457
+
8959
9458
  # Lists the User Licenses.
8960
9459
  # @param [String] parent
8961
9460
  # Required. The parent UserStore resource name, format: `projects/`project`/
8962
9461
  # locations/`location`/userStores/`user_store_id``.
8963
9462
  # @param [String] filter
8964
- # Optional. Filter for the list request. Supported fields: * `
8965
- # license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to
8966
- # list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list
8967
- # not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN`
8968
- # to list users who attempted login but no license assigned. * `
8969
- # license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users
8970
- # who attempted login but no license assigned.
9463
+ # Optional. Filter for the list request. Supported fields: * `license`_`
9464
+ # assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`
9465
+ # assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`
9466
+ # assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`
9467
+ # assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted
9468
+ # login but no license assigned. * `license`_`assignment`_`state !=
9469
+ # NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no
9470
+ # license assigned.
8971
9471
  # @param [Fixnum] page_size
8972
9472
  # Optional. Requested page size. Server may return fewer items than requested.
8973
9473
  # If unspecified, defaults to 10. The maximum value is 50; values above 50 will
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.56.0
4
+ version: 0.58.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.56.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.58.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
62
62
  rdoc_options: []
63
63
  require_paths: