google-apis-discoveryengine_v1alpha 0.28.0 → 0.30.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -190,6 +190,40 @@ module Google
190
190
  execute_or_queue_command(command, &block)
191
191
  end
192
192
 
193
+ # Estimates the data size to be used by a customer.
194
+ # @param [String] location
195
+ # Required. Full resource name of the Location, such as `projects/`project`/
196
+ # locations/`location``.
197
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest] google_cloud_discoveryengine_v1alpha_estimate_data_size_request_object
198
+ # @param [String] fields
199
+ # Selector specifying which fields to include in a partial response.
200
+ # @param [String] quota_user
201
+ # Available to use for quota purposes for server-side applications. Can be any
202
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
203
+ # @param [Google::Apis::RequestOptions] options
204
+ # Request-specific options
205
+ #
206
+ # @yield [result, err] Result & error if block supplied
207
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
208
+ # @yieldparam err [StandardError] error object if request failed
209
+ #
210
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
211
+ #
212
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
213
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
214
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
215
+ def estimate_project_location_data_size(location, google_cloud_discoveryengine_v1alpha_estimate_data_size_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
216
+ command = make_simple_command(:post, 'v1alpha/{+location}:estimateDataSize', options)
217
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest::Representation
218
+ command.request_object = google_cloud_discoveryengine_v1alpha_estimate_data_size_request_object
219
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
220
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
221
+ command.params['location'] = location unless location.nil?
222
+ command.query['fields'] = fields unless fields.nil?
223
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
224
+ execute_or_queue_command(command, &block)
225
+ end
226
+
193
227
  # Gets the latest state of a long-running operation. Clients can use this method
194
228
  # to poll the operation result at intervals as recommended by the API service.
195
229
  # @param [String] name
@@ -439,6 +473,40 @@ module Google
439
473
  execute_or_queue_command(command, &block)
440
474
  end
441
475
 
476
+ # Gets the SiteSearchEngine.
477
+ # @param [String] name
478
+ # Required. Resource name of SiteSearchEngine, such as `projects/`project`/
479
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
480
+ # siteSearchEngine`. If the caller does not have permission to access the [
481
+ # SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED
482
+ # error is returned.
483
+ # @param [String] fields
484
+ # Selector specifying which fields to include in a partial response.
485
+ # @param [String] quota_user
486
+ # Available to use for quota purposes for server-side applications. Can be any
487
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
488
+ # @param [Google::Apis::RequestOptions] options
489
+ # Request-specific options
490
+ #
491
+ # @yield [result, err] Result & error if block supplied
492
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine] parsed result object
493
+ # @yieldparam err [StandardError] error object if request failed
494
+ #
495
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine]
496
+ #
497
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
498
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
499
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
500
+ def get_project_location_collection_data_store_site_search_engine(name, fields: nil, quota_user: nil, options: nil, &block)
501
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
502
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine::Representation
503
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
504
+ command.params['name'] = name unless name.nil?
505
+ command.query['fields'] = fields unless fields.nil?
506
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
507
+ execute_or_queue_command(command, &block)
508
+ end
509
+
442
510
  # Lists all the DataStores associated with the project.
443
511
  # @param [String] parent
444
512
  # Required. The parent branch resource name, such as `projects/`project`/
@@ -528,6 +596,41 @@ module Google
528
596
  execute_or_queue_command(command, &block)
529
597
  end
530
598
 
599
+ # Trains a custom model.
600
+ # @param [String] data_store
601
+ # Required. The resource name of the Data Store, such as `projects/*/locations/
602
+ # global/collections/default_collection/dataStores/default_data_store`. This
603
+ # field is used to identify the data store where to train the models.
604
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest] google_cloud_discoveryengine_v1alpha_train_custom_model_request_object
605
+ # @param [String] fields
606
+ # Selector specifying which fields to include in a partial response.
607
+ # @param [String] quota_user
608
+ # Available to use for quota purposes for server-side applications. Can be any
609
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
610
+ # @param [Google::Apis::RequestOptions] options
611
+ # Request-specific options
612
+ #
613
+ # @yield [result, err] Result & error if block supplied
614
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
615
+ # @yieldparam err [StandardError] error object if request failed
616
+ #
617
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
618
+ #
619
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
620
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
621
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
622
+ def train_project_location_collection_data_store_custom_model(data_store, google_cloud_discoveryengine_v1alpha_train_custom_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
623
+ command = make_simple_command(:post, 'v1alpha/{+dataStore}:trainCustomModel', options)
624
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest::Representation
625
+ command.request_object = google_cloud_discoveryengine_v1alpha_train_custom_model_request_object
626
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
627
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
628
+ command.params['dataStore'] = data_store unless data_store.nil?
629
+ command.query['fields'] = fields unless fields.nil?
630
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
631
+ execute_or_queue_command(command, &block)
632
+ end
633
+
531
634
  # Creates a Document.
532
635
  # @param [String] parent
533
636
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -1066,7 +1169,8 @@ module Google
1066
1169
  # Conversation to update does not exist, a NOT_FOUND error is returned.
1067
1170
  # @param [String] name
1068
1171
  # Immutable. Fully qualified name `project/*/locations/global/collections/`
1069
- # collection`/dataStore/*/conversations/*`
1172
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
1173
+ # collections/`collection`/engines/*/conversations/*`.
1070
1174
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
1071
1175
  # @param [String] update_mask
1072
1176
  # Indicates which fields in the provided Conversation to update. The following
@@ -1580,11 +1684,47 @@ module Google
1580
1684
  execute_or_queue_command(command, &block)
1581
1685
  end
1582
1686
 
1583
- # Request on-demand recrawl for a list of URIs.
1687
+ # Verify target sites' ownership and validity. This API sends all the target
1688
+ # sites under site search engine for verification.
1689
+ # @param [String] parent
1690
+ # Required. The parent resource shared by all TargetSites being verified. `
1691
+ # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
1692
+ # data_store`/siteSearchEngine`.
1693
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest] google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object
1694
+ # @param [String] fields
1695
+ # Selector specifying which fields to include in a partial response.
1696
+ # @param [String] quota_user
1697
+ # Available to use for quota purposes for server-side applications. Can be any
1698
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1699
+ # @param [Google::Apis::RequestOptions] options
1700
+ # Request-specific options
1701
+ #
1702
+ # @yield [result, err] Result & error if block supplied
1703
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
1704
+ # @yieldparam err [StandardError] error object if request failed
1705
+ #
1706
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
1707
+ #
1708
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1709
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1710
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1711
+ def batch_project_location_collection_data_store_site_search_engine_verify_target_sites(parent, google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1712
+ command = make_simple_command(:post, 'v1alpha/{+parent}:batchVerifyTargetSites', options)
1713
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest::Representation
1714
+ command.request_object = google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object
1715
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1716
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1717
+ command.params['parent'] = parent unless parent.nil?
1718
+ command.query['fields'] = fields unless fields.nil?
1719
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1720
+ execute_or_queue_command(command, &block)
1721
+ end
1722
+
1723
+ # Downgrade from advanced site search to basic site search.
1584
1724
  # @param [String] site_search_engine
1585
- # Required. Full resource name of the SiteSearchEngine, such as `projects/*/
1586
- # locations/*/collections/*/dataStores/*/siteSearchEngine`.
1587
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest] google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
1725
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
1726
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
1727
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
1588
1728
  # @param [String] fields
1589
1729
  # Selector specifying which fields to include in a partial response.
1590
1730
  # @param [String] quota_user
@@ -1602,10 +1742,10 @@ module Google
1602
1742
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1603
1743
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1604
1744
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1605
- def recrawl_project_location_collection_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1606
- command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:recrawlUris', options)
1607
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest::Representation
1608
- command.request_object = google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
1745
+ def disable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1746
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
1747
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest::Representation
1748
+ command.request_object = google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
1609
1749
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1610
1750
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1611
1751
  command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
@@ -1614,10 +1754,11 @@ module Google
1614
1754
  execute_or_queue_command(command, &block)
1615
1755
  end
1616
1756
 
1617
- # Gets the latest state of a long-running operation. Clients can use this method
1618
- # to poll the operation result at intervals as recommended by the API service.
1619
- # @param [String] name
1620
- # The name of the operation resource.
1757
+ # Upgrade from basic site search to advanced site search.
1758
+ # @param [String] site_search_engine
1759
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
1760
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
1761
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
1621
1762
  # @param [String] fields
1622
1763
  # Selector specifying which fields to include in a partial response.
1623
1764
  # @param [String] quota_user
@@ -1635,26 +1776,34 @@ module Google
1635
1776
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1636
1777
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1637
1778
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1638
- def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1639
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
1779
+ def enable_project_location_collection_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1780
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
1781
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest::Representation
1782
+ command.request_object = google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
1640
1783
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1641
1784
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1642
- command.params['name'] = name unless name.nil?
1785
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
1643
1786
  command.query['fields'] = fields unless fields.nil?
1644
1787
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1645
1788
  execute_or_queue_command(command, &block)
1646
1789
  end
1647
1790
 
1648
- # Lists operations that match the specified filter in the request. If the server
1649
- # doesn't support this method, it returns `UNIMPLEMENTED`.
1650
- # @param [String] name
1651
- # The name of the operation's parent resource.
1652
- # @param [String] filter
1653
- # The standard list filter.
1791
+ # Returns list of target sites with its domain verification status. This method
1792
+ # can only be called under data store with BASIC_SITE_SEARCH state at the moment.
1793
+ # @param [String] site_search_engine
1794
+ # Required. The site search engine resource under which we fetch all the domain
1795
+ # verification status. `projects/`project`/locations/`location`/collections/`
1796
+ # collection`/dataStores/`data_store`/siteSearchEngine`.
1654
1797
  # @param [Fixnum] page_size
1655
- # The standard list page size.
1798
+ # Requested page size. Server may return fewer items than requested. If
1799
+ # unspecified, server will pick an appropriate default. The maximum value is
1800
+ # 1000; values above 1000 will be coerced to 1000. If this field is negative, an
1801
+ # INVALID_ARGUMENT error is returned.
1656
1802
  # @param [String] page_token
1657
- # The standard list page token.
1803
+ # A page token, received from a previous `FetchDomainVerificationStatus` call.
1804
+ # Provide this to retrieve the subsequent page. When paginating, all other
1805
+ # parameters provided to `FetchDomainVerificationStatus` must match the call
1806
+ # that provided the page token.
1658
1807
  # @param [String] fields
1659
1808
  # Selector specifying which fields to include in a partial response.
1660
1809
  # @param [String] quota_user
@@ -1664,20 +1813,19 @@ module Google
1664
1813
  # Request-specific options
1665
1814
  #
1666
1815
  # @yield [result, err] Result & error if block supplied
1667
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
1816
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse] parsed result object
1668
1817
  # @yieldparam err [StandardError] error object if request failed
1669
1818
  #
1670
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
1819
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse]
1671
1820
  #
1672
1821
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1673
1822
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1674
1823
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1675
- def list_project_location_collection_data_store_site_search_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1676
- command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
1677
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
1678
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
1679
- command.params['name'] = name unless name.nil?
1680
- command.query['filter'] = filter unless filter.nil?
1824
+ def fetch_project_location_collection_data_store_site_search_engine_domain_verification_status(site_search_engine, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1825
+ command = make_simple_command(:get, 'v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus', options)
1826
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse::Representation
1827
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
1828
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
1681
1829
  command.query['pageSize'] = page_size unless page_size.nil?
1682
1830
  command.query['pageToken'] = page_token unless page_token.nil?
1683
1831
  command.query['fields'] = fields unless fields.nil?
@@ -1685,6 +1833,40 @@ module Google
1685
1833
  execute_or_queue_command(command, &block)
1686
1834
  end
1687
1835
 
1836
+ # Request on-demand recrawl for a list of URIs.
1837
+ # @param [String] site_search_engine
1838
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/*/
1839
+ # locations/*/collections/*/dataStores/*/siteSearchEngine`.
1840
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest] google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
1841
+ # @param [String] fields
1842
+ # Selector specifying which fields to include in a partial response.
1843
+ # @param [String] quota_user
1844
+ # Available to use for quota purposes for server-side applications. Can be any
1845
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1846
+ # @param [Google::Apis::RequestOptions] options
1847
+ # Request-specific options
1848
+ #
1849
+ # @yield [result, err] Result & error if block supplied
1850
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
1851
+ # @yieldparam err [StandardError] error object if request failed
1852
+ #
1853
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
1854
+ #
1855
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1856
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1857
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1858
+ def recrawl_project_location_collection_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1859
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:recrawlUris', options)
1860
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest::Representation
1861
+ command.request_object = google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
1862
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1863
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1864
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
1865
+ command.query['fields'] = fields unless fields.nil?
1866
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1867
+ execute_or_queue_command(command, &block)
1868
+ end
1869
+
1688
1870
  # Gets the latest state of a long-running operation. Clients can use this method
1689
1871
  # to poll the operation result at intervals as recommended by the API service.
1690
1872
  # @param [String] name
@@ -1706,7 +1888,7 @@ module Google
1706
1888
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1707
1889
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1708
1890
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1709
- def get_project_location_collection_data_store_site_search_engine_target_site_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1891
+ def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1710
1892
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
1711
1893
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1712
1894
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
@@ -1743,7 +1925,7 @@ module Google
1743
1925
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1744
1926
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1745
1927
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1746
- def list_project_location_collection_data_store_site_search_engine_target_site_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1928
+ def list_project_location_collection_data_store_site_search_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1747
1929
  command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
1748
1930
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
1749
1931
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
@@ -1756,24 +1938,13 @@ module Google
1756
1938
  execute_or_queue_command(command, &block)
1757
1939
  end
1758
1940
 
1759
- # Writes a single user event from the browser. This uses a GET request to due to
1760
- # browser restriction of POST-ing to a third-party domain. This method is used
1761
- # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
1762
- # Users should not call this method directly.
1941
+ # Creates TargetSite in a batch.
1763
1942
  # @param [String] parent
1764
- # Required. The parent DataStore resource name, such as `projects/`project`/
1765
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
1766
- # @param [Fixnum] ets
1767
- # The event timestamp in milliseconds. This prevents browser caching of
1768
- # otherwise identical get requests. The name is abbreviated to reduce the
1769
- # payload bytes.
1770
- # @param [String] uri
1771
- # The URL including cgi-parameters but excluding the hash fragment with a length
1772
- # limit of 5,000 characters. This is often more useful than the referer URL,
1773
- # because many browsers only send the domain for third-party requests.
1774
- # @param [String] user_event
1775
- # Required. URL encoded UserEvent proto with a length limit of 2,000,000
1776
- # characters.
1943
+ # Required. The parent resource shared by all TargetSites being created. `
1944
+ # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
1945
+ # data_store`/siteSearchEngine`. The parent field in the CreateBookRequest
1946
+ # messages must either be empty or match this field.
1947
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest] google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object
1777
1948
  # @param [String] fields
1778
1949
  # Selector specifying which fields to include in a partial response.
1779
1950
  # @param [String] quota_user
@@ -1783,36 +1954,32 @@ module Google
1783
1954
  # Request-specific options
1784
1955
  #
1785
1956
  # @yield [result, err] Result & error if block supplied
1786
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody] parsed result object
1957
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
1787
1958
  # @yieldparam err [StandardError] error object if request failed
1788
1959
  #
1789
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody]
1960
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
1790
1961
  #
1791
1962
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1792
1963
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1793
1964
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1794
- def collect_project_location_collection_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
1795
- command = make_simple_command(:get, 'v1alpha/{+parent}/userEvents:collect', options)
1796
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody::Representation
1797
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody
1965
+ def batch_project_location_collection_data_store_site_search_engine_target_site_create(parent, google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1966
+ command = make_simple_command(:post, 'v1alpha/{+parent}/targetSites:batchCreate', options)
1967
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest::Representation
1968
+ command.request_object = google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object
1969
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1970
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1798
1971
  command.params['parent'] = parent unless parent.nil?
1799
- command.query['ets'] = ets unless ets.nil?
1800
- command.query['uri'] = uri unless uri.nil?
1801
- command.query['userEvent'] = user_event unless user_event.nil?
1802
1972
  command.query['fields'] = fields unless fields.nil?
1803
1973
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1804
1974
  execute_or_queue_command(command, &block)
1805
1975
  end
1806
1976
 
1807
- # Bulk import of User events. Request processing might be synchronous. Events
1808
- # that already exist are skipped. Use this method for backfilling historical
1809
- # user events. Operation.response is of type ImportResponse. Note that it is
1810
- # possible for a subset of the items to be successfully inserted. Operation.
1811
- # metadata is of type ImportMetadata.
1977
+ # Creates a TargetSite.
1812
1978
  # @param [String] parent
1813
- # Required. Parent DataStore resource name, of the form `projects/`project`/
1814
- # locations/`location`/collections/`collection`/dataStores/`data_store``
1815
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest] google_cloud_discoveryengine_v1alpha_import_user_events_request_object
1979
+ # Required. Parent resource name of TargetSite, such as `projects/`project`/
1980
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
1981
+ # siteSearchEngine`.
1982
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] google_cloud_discoveryengine_v1alpha_target_site_object
1816
1983
  # @param [String] fields
1817
1984
  # Selector specifying which fields to include in a partial response.
1818
1985
  # @param [String] quota_user
@@ -1830,10 +1997,10 @@ module Google
1830
1997
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1831
1998
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1832
1999
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1833
- def import_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1834
- command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:import', options)
1835
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest::Representation
1836
- command.request_object = google_cloud_discoveryengine_v1alpha_import_user_events_request_object
2000
+ def create_project_location_collection_data_store_site_search_engine_target_site(parent, google_cloud_discoveryengine_v1alpha_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2001
+ command = make_simple_command(:post, 'v1alpha/{+parent}/targetSites', options)
2002
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
2003
+ command.request_object = google_cloud_discoveryengine_v1alpha_target_site_object
1837
2004
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1838
2005
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1839
2006
  command.params['parent'] = parent unless parent.nil?
@@ -1842,15 +2009,14 @@ module Google
1842
2009
  execute_or_queue_command(command, &block)
1843
2010
  end
1844
2011
 
1845
- # Deletes permanently all user events specified by the filter provided.
1846
- # Depending on the number of events specified by the filter, this operation
1847
- # could take hours or days to complete. To test a filter, use the list command
1848
- # first.
1849
- # @param [String] parent
1850
- # Required. The resource name of the catalog under which the events are created.
1851
- # The format is `projects/$`projectId`/locations/global/collections/`$
1852
- # collectionId`/dataStores/$`dataStoreId``
1853
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest] google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
2012
+ # Deletes a TargetSite.
2013
+ # @param [String] name
2014
+ # Required. Full resource name of TargetSite, such as `projects/`project`/
2015
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
2016
+ # siteSearchEngine/targetSites/`target_site``. If the caller does not have
2017
+ # permission to access the TargetSite, regardless of whether or not it exists, a
2018
+ # PERMISSION_DENIED error is returned. If the requested TargetSite does not
2019
+ # exist, a NOT_FOUND error is returned.
1854
2020
  # @param [String] fields
1855
2021
  # Selector specifying which fields to include in a partial response.
1856
2022
  # @param [String] quota_user
@@ -1868,23 +2034,24 @@ module Google
1868
2034
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1869
2035
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1870
2036
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1871
- def purge_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1872
- command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:purge', options)
1873
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest::Representation
1874
- command.request_object = google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
2037
+ def delete_project_location_collection_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
2038
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1875
2039
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1876
2040
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1877
- command.params['parent'] = parent unless parent.nil?
2041
+ command.params['name'] = name unless name.nil?
1878
2042
  command.query['fields'] = fields unless fields.nil?
1879
2043
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1880
2044
  execute_or_queue_command(command, &block)
1881
2045
  end
1882
2046
 
1883
- # Writes a single user event.
1884
- # @param [String] parent
1885
- # Required. The parent DataStore resource name, such as `projects/`project`/
1886
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
1887
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
2047
+ # Gets a TargetSite.
2048
+ # @param [String] name
2049
+ # Required. Full resource name of TargetSite, such as `projects/`project`/
2050
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
2051
+ # siteSearchEngine/targetSites/`target_site``. If the caller does not have
2052
+ # permission to access the TargetSite, regardless of whether or not it exists, a
2053
+ # PERMISSION_DENIED error is returned. If the requested TargetSite does not
2054
+ # exist, a NOT_FOUND error is returned.
1888
2055
  # @param [String] fields
1889
2056
  # Selector specifying which fields to include in a partial response.
1890
2057
  # @param [String] quota_user
@@ -1894,32 +2061,340 @@ module Google
1894
2061
  # Request-specific options
1895
2062
  #
1896
2063
  # @yield [result, err] Result & error if block supplied
1897
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] parsed result object
2064
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] parsed result object
1898
2065
  # @yieldparam err [StandardError] error object if request failed
1899
2066
  #
1900
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent]
2067
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite]
1901
2068
  #
1902
2069
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1903
2070
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1904
2071
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1905
- 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)
1906
- command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
1907
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
1908
- command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
1909
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
1910
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
1911
- command.params['parent'] = parent unless parent.nil?
2072
+ def get_project_location_collection_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
2073
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2074
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
2075
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite
2076
+ command.params['name'] = name unless name.nil?
1912
2077
  command.query['fields'] = fields unless fields.nil?
1913
2078
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1914
2079
  execute_or_queue_command(command, &block)
1915
2080
  end
1916
2081
 
1917
- # Creates a Engine.
2082
+ # Gets a list of TargetSites.
1918
2083
  # @param [String] parent
1919
- # Required. The parent resource name, such as `projects/`project`/locations/`
1920
- # location`/collections/`collection``.
1921
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] google_cloud_discoveryengine_v1alpha_engine_object
1922
- # @param [String] engine_id
2084
+ # Required. The parent site search engine resource name, such as `projects/`
2085
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
2086
+ # siteSearchEngine`. If the caller does not have permission to list TargetSites
2087
+ # under this site search engine, regardless of whether or not this branch exists,
2088
+ # a PERMISSION_DENIED error is returned.
2089
+ # @param [Fixnum] page_size
2090
+ # Requested page size. Server may return fewer items than requested. If
2091
+ # unspecified, server will pick an appropriate default. The maximum value is
2092
+ # 1000; values above 1000 will be coerced to 1000. If this field is negative, an
2093
+ # INVALID_ARGUMENT error is returned.
2094
+ # @param [String] page_token
2095
+ # A page token, received from a previous `ListTargetSites` call. Provide this to
2096
+ # retrieve the subsequent page. When paginating, all other parameters provided
2097
+ # to `ListTargetSites` must match the call that provided the page token.
2098
+ # @param [String] fields
2099
+ # Selector specifying which fields to include in a partial response.
2100
+ # @param [String] quota_user
2101
+ # Available to use for quota purposes for server-side applications. Can be any
2102
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2103
+ # @param [Google::Apis::RequestOptions] options
2104
+ # Request-specific options
2105
+ #
2106
+ # @yield [result, err] Result & error if block supplied
2107
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse] parsed result object
2108
+ # @yieldparam err [StandardError] error object if request failed
2109
+ #
2110
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse]
2111
+ #
2112
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2113
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2114
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2115
+ def list_project_location_collection_data_store_site_search_engine_target_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2116
+ command = make_simple_command(:get, 'v1alpha/{+parent}/targetSites', options)
2117
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse::Representation
2118
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse
2119
+ command.params['parent'] = parent unless parent.nil?
2120
+ command.query['pageSize'] = page_size unless page_size.nil?
2121
+ command.query['pageToken'] = page_token unless page_token.nil?
2122
+ command.query['fields'] = fields unless fields.nil?
2123
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2124
+ execute_or_queue_command(command, &block)
2125
+ end
2126
+
2127
+ # Updates a TargetSite.
2128
+ # @param [String] name
2129
+ # Output only. The fully qualified resource name of the target site. `projects/`
2130
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
2131
+ # siteSearchEngine/targetSites/`target_site`` The `target_site_id` is system-
2132
+ # generated.
2133
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] google_cloud_discoveryengine_v1alpha_target_site_object
2134
+ # @param [String] fields
2135
+ # Selector specifying which fields to include in a partial response.
2136
+ # @param [String] quota_user
2137
+ # Available to use for quota purposes for server-side applications. Can be any
2138
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2139
+ # @param [Google::Apis::RequestOptions] options
2140
+ # Request-specific options
2141
+ #
2142
+ # @yield [result, err] Result & error if block supplied
2143
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2144
+ # @yieldparam err [StandardError] error object if request failed
2145
+ #
2146
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2147
+ #
2148
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2149
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2150
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2151
+ def patch_project_location_collection_data_store_site_search_engine_target_site(name, google_cloud_discoveryengine_v1alpha_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2152
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2153
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
2154
+ command.request_object = google_cloud_discoveryengine_v1alpha_target_site_object
2155
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2156
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2157
+ command.params['name'] = name unless name.nil?
2158
+ command.query['fields'] = fields unless fields.nil?
2159
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2160
+ execute_or_queue_command(command, &block)
2161
+ end
2162
+
2163
+ # Gets the latest state of a long-running operation. Clients can use this method
2164
+ # to poll the operation result at intervals as recommended by the API service.
2165
+ # @param [String] name
2166
+ # The name of the operation resource.
2167
+ # @param [String] fields
2168
+ # Selector specifying which fields to include in a partial response.
2169
+ # @param [String] quota_user
2170
+ # Available to use for quota purposes for server-side applications. Can be any
2171
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2172
+ # @param [Google::Apis::RequestOptions] options
2173
+ # Request-specific options
2174
+ #
2175
+ # @yield [result, err] Result & error if block supplied
2176
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2177
+ # @yieldparam err [StandardError] error object if request failed
2178
+ #
2179
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2180
+ #
2181
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2182
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2183
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2184
+ def get_project_location_collection_data_store_site_search_engine_target_site_operation(name, fields: nil, quota_user: nil, options: nil, &block)
2185
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2186
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2187
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2188
+ command.params['name'] = name unless name.nil?
2189
+ command.query['fields'] = fields unless fields.nil?
2190
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2191
+ execute_or_queue_command(command, &block)
2192
+ end
2193
+
2194
+ # Lists operations that match the specified filter in the request. If the server
2195
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
2196
+ # @param [String] name
2197
+ # The name of the operation's parent resource.
2198
+ # @param [String] filter
2199
+ # The standard list filter.
2200
+ # @param [Fixnum] page_size
2201
+ # The standard list page size.
2202
+ # @param [String] page_token
2203
+ # The standard list page token.
2204
+ # @param [String] fields
2205
+ # Selector specifying which fields to include in a partial response.
2206
+ # @param [String] quota_user
2207
+ # Available to use for quota purposes for server-side applications. Can be any
2208
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2209
+ # @param [Google::Apis::RequestOptions] options
2210
+ # Request-specific options
2211
+ #
2212
+ # @yield [result, err] Result & error if block supplied
2213
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
2214
+ # @yieldparam err [StandardError] error object if request failed
2215
+ #
2216
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
2217
+ #
2218
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2219
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2220
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2221
+ def list_project_location_collection_data_store_site_search_engine_target_site_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2222
+ command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
2223
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
2224
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
2225
+ command.params['name'] = name unless name.nil?
2226
+ command.query['filter'] = filter unless filter.nil?
2227
+ command.query['pageSize'] = page_size unless page_size.nil?
2228
+ command.query['pageToken'] = page_token unless page_token.nil?
2229
+ command.query['fields'] = fields unless fields.nil?
2230
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2231
+ execute_or_queue_command(command, &block)
2232
+ end
2233
+
2234
+ # Writes a single user event from the browser. This uses a GET request to due to
2235
+ # browser restriction of POST-ing to a third-party domain. This method is used
2236
+ # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
2237
+ # Users should not call this method directly.
2238
+ # @param [String] parent
2239
+ # Required. The parent DataStore resource name, such as `projects/`project`/
2240
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
2241
+ # @param [Fixnum] ets
2242
+ # The event timestamp in milliseconds. This prevents browser caching of
2243
+ # otherwise identical get requests. The name is abbreviated to reduce the
2244
+ # payload bytes.
2245
+ # @param [String] uri
2246
+ # The URL including cgi-parameters but excluding the hash fragment with a length
2247
+ # limit of 5,000 characters. This is often more useful than the referer URL,
2248
+ # because many browsers only send the domain for third-party requests.
2249
+ # @param [String] user_event
2250
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
2251
+ # characters.
2252
+ # @param [String] fields
2253
+ # Selector specifying which fields to include in a partial response.
2254
+ # @param [String] quota_user
2255
+ # Available to use for quota purposes for server-side applications. Can be any
2256
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2257
+ # @param [Google::Apis::RequestOptions] options
2258
+ # Request-specific options
2259
+ #
2260
+ # @yield [result, err] Result & error if block supplied
2261
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody] parsed result object
2262
+ # @yieldparam err [StandardError] error object if request failed
2263
+ #
2264
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody]
2265
+ #
2266
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2267
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2268
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2269
+ def collect_project_location_collection_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
2270
+ command = make_simple_command(:get, 'v1alpha/{+parent}/userEvents:collect', options)
2271
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody::Representation
2272
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody
2273
+ command.params['parent'] = parent unless parent.nil?
2274
+ command.query['ets'] = ets unless ets.nil?
2275
+ command.query['uri'] = uri unless uri.nil?
2276
+ command.query['userEvent'] = user_event unless user_event.nil?
2277
+ command.query['fields'] = fields unless fields.nil?
2278
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2279
+ execute_or_queue_command(command, &block)
2280
+ end
2281
+
2282
+ # Bulk import of User events. Request processing might be synchronous. Events
2283
+ # that already exist are skipped. Use this method for backfilling historical
2284
+ # user events. Operation.response is of type ImportResponse. Note that it is
2285
+ # possible for a subset of the items to be successfully inserted. Operation.
2286
+ # metadata is of type ImportMetadata.
2287
+ # @param [String] parent
2288
+ # Required. Parent DataStore resource name, of the form `projects/`project`/
2289
+ # locations/`location`/collections/`collection`/dataStores/`data_store``
2290
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest] google_cloud_discoveryengine_v1alpha_import_user_events_request_object
2291
+ # @param [String] fields
2292
+ # Selector specifying which fields to include in a partial response.
2293
+ # @param [String] quota_user
2294
+ # Available to use for quota purposes for server-side applications. Can be any
2295
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2296
+ # @param [Google::Apis::RequestOptions] options
2297
+ # Request-specific options
2298
+ #
2299
+ # @yield [result, err] Result & error if block supplied
2300
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2301
+ # @yieldparam err [StandardError] error object if request failed
2302
+ #
2303
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2304
+ #
2305
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2306
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2307
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2308
+ def import_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2309
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:import', options)
2310
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest::Representation
2311
+ command.request_object = google_cloud_discoveryengine_v1alpha_import_user_events_request_object
2312
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2313
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2314
+ command.params['parent'] = parent unless parent.nil?
2315
+ command.query['fields'] = fields unless fields.nil?
2316
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2317
+ execute_or_queue_command(command, &block)
2318
+ end
2319
+
2320
+ # Deletes permanently all user events specified by the filter provided.
2321
+ # Depending on the number of events specified by the filter, this operation
2322
+ # could take hours or days to complete. To test a filter, use the list command
2323
+ # first.
2324
+ # @param [String] parent
2325
+ # Required. The resource name of the catalog under which the events are created.
2326
+ # The format is `projects/$`projectId`/locations/global/collections/`$
2327
+ # collectionId`/dataStores/$`dataStoreId``
2328
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest] google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
2329
+ # @param [String] fields
2330
+ # Selector specifying which fields to include in a partial response.
2331
+ # @param [String] quota_user
2332
+ # Available to use for quota purposes for server-side applications. Can be any
2333
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2334
+ # @param [Google::Apis::RequestOptions] options
2335
+ # Request-specific options
2336
+ #
2337
+ # @yield [result, err] Result & error if block supplied
2338
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2339
+ # @yieldparam err [StandardError] error object if request failed
2340
+ #
2341
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2342
+ #
2343
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2344
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2345
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2346
+ def purge_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2347
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:purge', options)
2348
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest::Representation
2349
+ command.request_object = google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
2350
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2351
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2352
+ command.params['parent'] = parent unless parent.nil?
2353
+ command.query['fields'] = fields unless fields.nil?
2354
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2355
+ execute_or_queue_command(command, &block)
2356
+ end
2357
+
2358
+ # Writes a single user event.
2359
+ # @param [String] parent
2360
+ # Required. The parent DataStore resource name, such as `projects/`project`/
2361
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
2362
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
2363
+ # @param [String] fields
2364
+ # Selector specifying which fields to include in a partial response.
2365
+ # @param [String] quota_user
2366
+ # Available to use for quota purposes for server-side applications. Can be any
2367
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2368
+ # @param [Google::Apis::RequestOptions] options
2369
+ # Request-specific options
2370
+ #
2371
+ # @yield [result, err] Result & error if block supplied
2372
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] parsed result object
2373
+ # @yieldparam err [StandardError] error object if request failed
2374
+ #
2375
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent]
2376
+ #
2377
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2378
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2379
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2380
+ 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)
2381
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
2382
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
2383
+ command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
2384
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
2385
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
2386
+ command.params['parent'] = parent unless parent.nil?
2387
+ command.query['fields'] = fields unless fields.nil?
2388
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2389
+ execute_or_queue_command(command, &block)
2390
+ end
2391
+
2392
+ # Creates a Engine.
2393
+ # @param [String] parent
2394
+ # Required. The parent resource name, such as `projects/`project`/locations/`
2395
+ # location`/collections/`collection``.
2396
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] google_cloud_discoveryengine_v1alpha_engine_object
2397
+ # @param [String] engine_id
1923
2398
  # Required. The ID to use for the Engine, which will become the final component
1924
2399
  # of the Engine's resource name. This field must conform to [RFC-1034](https://
1925
2400
  # tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
@@ -2187,21 +2662,249 @@ module Google
2187
2662
  # Request-specific options
2188
2663
  #
2189
2664
  # @yield [result, err] Result & error if block supplied
2190
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2665
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2666
+ # @yieldparam err [StandardError] error object if request failed
2667
+ #
2668
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2669
+ #
2670
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2671
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2672
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2673
+ def tune_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_tune_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2674
+ command = make_simple_command(:post, 'v1alpha/{+name}:tune', options)
2675
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest::Representation
2676
+ command.request_object = google_cloud_discoveryengine_v1alpha_tune_engine_request_object
2677
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2678
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2679
+ command.params['name'] = name unless name.nil?
2680
+ command.query['fields'] = fields unless fields.nil?
2681
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2682
+ execute_or_queue_command(command, &block)
2683
+ end
2684
+
2685
+ # Converses a conversation.
2686
+ # @param [String] name
2687
+ # Required. The resource name of the Conversation to get. Format: `projects/`
2688
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2689
+ # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
2690
+ # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
2691
+ # conversations/-` to activate auto session mode, which automatically creates a
2692
+ # new conversation inside a ConverseConversation session.
2693
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest] google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
2694
+ # @param [String] fields
2695
+ # Selector specifying which fields to include in a partial response.
2696
+ # @param [String] quota_user
2697
+ # Available to use for quota purposes for server-side applications. Can be any
2698
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2699
+ # @param [Google::Apis::RequestOptions] options
2700
+ # Request-specific options
2701
+ #
2702
+ # @yield [result, err] Result & error if block supplied
2703
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse] parsed result object
2704
+ # @yieldparam err [StandardError] error object if request failed
2705
+ #
2706
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse]
2707
+ #
2708
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2709
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2710
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2711
+ def converse_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1alpha_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2712
+ command = make_simple_command(:post, 'v1alpha/{+name}:converse', options)
2713
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest::Representation
2714
+ command.request_object = google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
2715
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse::Representation
2716
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse
2717
+ command.params['name'] = name unless name.nil?
2718
+ command.query['fields'] = fields unless fields.nil?
2719
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2720
+ execute_or_queue_command(command, &block)
2721
+ end
2722
+
2723
+ # Creates a Conversation. If the Conversation to create already exists, an
2724
+ # ALREADY_EXISTS error is returned.
2725
+ # @param [String] parent
2726
+ # Required. Full resource name of parent data store. Format: `projects/`
2727
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2728
+ # data_store_id``
2729
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
2730
+ # @param [String] fields
2731
+ # Selector specifying which fields to include in a partial response.
2732
+ # @param [String] quota_user
2733
+ # Available to use for quota purposes for server-side applications. Can be any
2734
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2735
+ # @param [Google::Apis::RequestOptions] options
2736
+ # Request-specific options
2737
+ #
2738
+ # @yield [result, err] Result & error if block supplied
2739
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
2740
+ # @yieldparam err [StandardError] error object if request failed
2741
+ #
2742
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
2743
+ #
2744
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2745
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2746
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2747
+ def create_project_location_collection_engine_conversation(parent, google_cloud_discoveryengine_v1alpha_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2748
+ command = make_simple_command(:post, 'v1alpha/{+parent}/conversations', options)
2749
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
2750
+ command.request_object = google_cloud_discoveryengine_v1alpha_conversation_object
2751
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
2752
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
2753
+ command.params['parent'] = parent unless parent.nil?
2754
+ command.query['fields'] = fields unless fields.nil?
2755
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2756
+ execute_or_queue_command(command, &block)
2757
+ end
2758
+
2759
+ # Deletes a Conversation. If the Conversation to delete does not exist, a
2760
+ # NOT_FOUND error is returned.
2761
+ # @param [String] name
2762
+ # Required. The resource name of the Conversation to delete. Format: `projects/`
2763
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2764
+ # data_store_id`/conversations/`conversation_id``
2765
+ # @param [String] fields
2766
+ # Selector specifying which fields to include in a partial response.
2767
+ # @param [String] quota_user
2768
+ # Available to use for quota purposes for server-side applications. Can be any
2769
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2770
+ # @param [Google::Apis::RequestOptions] options
2771
+ # Request-specific options
2772
+ #
2773
+ # @yield [result, err] Result & error if block supplied
2774
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
2775
+ # @yieldparam err [StandardError] error object if request failed
2776
+ #
2777
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
2778
+ #
2779
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2780
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2781
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2782
+ def delete_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
2783
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
2784
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
2785
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
2786
+ command.params['name'] = name unless name.nil?
2787
+ command.query['fields'] = fields unless fields.nil?
2788
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2789
+ execute_or_queue_command(command, &block)
2790
+ end
2791
+
2792
+ # Gets a Conversation.
2793
+ # @param [String] name
2794
+ # Required. The resource name of the Conversation to get. Format: `projects/`
2795
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2796
+ # data_store_id`/conversations/`conversation_id``
2797
+ # @param [String] fields
2798
+ # Selector specifying which fields to include in a partial response.
2799
+ # @param [String] quota_user
2800
+ # Available to use for quota purposes for server-side applications. Can be any
2801
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2802
+ # @param [Google::Apis::RequestOptions] options
2803
+ # Request-specific options
2804
+ #
2805
+ # @yield [result, err] Result & error if block supplied
2806
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
2807
+ # @yieldparam err [StandardError] error object if request failed
2808
+ #
2809
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
2810
+ #
2811
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2812
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2813
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2814
+ def get_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
2815
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2816
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
2817
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
2818
+ command.params['name'] = name unless name.nil?
2819
+ command.query['fields'] = fields unless fields.nil?
2820
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2821
+ execute_or_queue_command(command, &block)
2822
+ end
2823
+
2824
+ # Lists all Conversations by their parent DataStore.
2825
+ # @param [String] parent
2826
+ # Required. The data store resource name. Format: `projects/`project_number`/
2827
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
2828
+ # @param [String] filter
2829
+ # A filter to apply on the list results. The supported features are:
2830
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
2831
+ # @param [String] order_by
2832
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
2833
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
2834
+ # create_time` * `conversation_name` Example: "update_time desc" "create_time"
2835
+ # @param [Fixnum] page_size
2836
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
2837
+ # allowed value is 1000.
2838
+ # @param [String] page_token
2839
+ # A page token, received from a previous `ListConversations` call. Provide this
2840
+ # to retrieve the subsequent page.
2841
+ # @param [String] fields
2842
+ # Selector specifying which fields to include in a partial response.
2843
+ # @param [String] quota_user
2844
+ # Available to use for quota purposes for server-side applications. Can be any
2845
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2846
+ # @param [Google::Apis::RequestOptions] options
2847
+ # Request-specific options
2848
+ #
2849
+ # @yield [result, err] Result & error if block supplied
2850
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse] parsed result object
2851
+ # @yieldparam err [StandardError] error object if request failed
2852
+ #
2853
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse]
2854
+ #
2855
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2856
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2857
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2858
+ def list_project_location_collection_engine_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2859
+ command = make_simple_command(:get, 'v1alpha/{+parent}/conversations', options)
2860
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse::Representation
2861
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse
2862
+ command.params['parent'] = parent unless parent.nil?
2863
+ command.query['filter'] = filter unless filter.nil?
2864
+ command.query['orderBy'] = order_by unless order_by.nil?
2865
+ command.query['pageSize'] = page_size unless page_size.nil?
2866
+ command.query['pageToken'] = page_token unless page_token.nil?
2867
+ command.query['fields'] = fields unless fields.nil?
2868
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2869
+ execute_or_queue_command(command, &block)
2870
+ end
2871
+
2872
+ # Updates a Conversation. Conversation action type cannot be changed. If the
2873
+ # Conversation to update does not exist, a NOT_FOUND error is returned.
2874
+ # @param [String] name
2875
+ # Immutable. Fully qualified name `project/*/locations/global/collections/`
2876
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
2877
+ # collections/`collection`/engines/*/conversations/*`.
2878
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
2879
+ # @param [String] update_mask
2880
+ # Indicates which fields in the provided Conversation to update. The following
2881
+ # are NOT supported: * conversation.name If not set or empty, all supported
2882
+ # fields are updated.
2883
+ # @param [String] fields
2884
+ # Selector specifying which fields to include in a partial response.
2885
+ # @param [String] quota_user
2886
+ # Available to use for quota purposes for server-side applications. Can be any
2887
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2888
+ # @param [Google::Apis::RequestOptions] options
2889
+ # Request-specific options
2890
+ #
2891
+ # @yield [result, err] Result & error if block supplied
2892
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
2191
2893
  # @yieldparam err [StandardError] error object if request failed
2192
2894
  #
2193
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2895
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
2194
2896
  #
2195
2897
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2196
2898
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2197
2899
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2198
- def tune_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_tune_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2199
- command = make_simple_command(:post, 'v1alpha/{+name}:tune', options)
2200
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest::Representation
2201
- command.request_object = google_cloud_discoveryengine_v1alpha_tune_engine_request_object
2202
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2203
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2900
+ def patch_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1alpha_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2901
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2902
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
2903
+ command.request_object = google_cloud_discoveryengine_v1alpha_conversation_object
2904
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
2905
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
2204
2906
  command.params['name'] = name unless name.nil?
2907
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2205
2908
  command.query['fields'] = fields unless fields.nil?
2206
2909
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2207
2910
  execute_or_queue_command(command, &block)
@@ -2605,6 +3308,40 @@ module Google
2605
3308
  execute_or_queue_command(command, &block)
2606
3309
  end
2607
3310
 
3311
+ # Gets the SiteSearchEngine.
3312
+ # @param [String] name
3313
+ # Required. Resource name of SiteSearchEngine, such as `projects/`project`/
3314
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
3315
+ # siteSearchEngine`. If the caller does not have permission to access the [
3316
+ # SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED
3317
+ # error is returned.
3318
+ # @param [String] fields
3319
+ # Selector specifying which fields to include in a partial response.
3320
+ # @param [String] quota_user
3321
+ # Available to use for quota purposes for server-side applications. Can be any
3322
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3323
+ # @param [Google::Apis::RequestOptions] options
3324
+ # Request-specific options
3325
+ #
3326
+ # @yield [result, err] Result & error if block supplied
3327
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine] parsed result object
3328
+ # @yieldparam err [StandardError] error object if request failed
3329
+ #
3330
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine]
3331
+ #
3332
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3333
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3334
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3335
+ def get_project_location_data_store_site_search_engine(name, fields: nil, quota_user: nil, options: nil, &block)
3336
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
3337
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine::Representation
3338
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
3339
+ command.params['name'] = name unless name.nil?
3340
+ command.query['fields'] = fields unless fields.nil?
3341
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3342
+ execute_or_queue_command(command, &block)
3343
+ end
3344
+
2608
3345
  # Lists all the DataStores associated with the project.
2609
3346
  # @param [String] parent
2610
3347
  # Required. The parent branch resource name, such as `projects/`project`/
@@ -3232,7 +3969,8 @@ module Google
3232
3969
  # Conversation to update does not exist, a NOT_FOUND error is returned.
3233
3970
  # @param [String] name
3234
3971
  # Immutable. Fully qualified name `project/*/locations/global/collections/`
3235
- # collection`/dataStore/*/conversations/*`
3972
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
3973
+ # collections/`collection`/engines/*/conversations/*`.
3236
3974
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
3237
3975
  # @param [String] update_mask
3238
3976
  # Indicates which fields in the provided Conversation to update. The following
@@ -3675,6 +4413,74 @@ module Google
3675
4413
  execute_or_queue_command(command, &block)
3676
4414
  end
3677
4415
 
4416
+ # Downgrade from advanced site search to basic site search.
4417
+ # @param [String] site_search_engine
4418
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
4419
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
4420
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
4421
+ # @param [String] fields
4422
+ # Selector specifying which fields to include in a partial response.
4423
+ # @param [String] quota_user
4424
+ # Available to use for quota purposes for server-side applications. Can be any
4425
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4426
+ # @param [Google::Apis::RequestOptions] options
4427
+ # Request-specific options
4428
+ #
4429
+ # @yield [result, err] Result & error if block supplied
4430
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4431
+ # @yieldparam err [StandardError] error object if request failed
4432
+ #
4433
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4434
+ #
4435
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4436
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4437
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4438
+ def disable_project_location_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4439
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
4440
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest::Representation
4441
+ command.request_object = google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
4442
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4443
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4444
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
4445
+ command.query['fields'] = fields unless fields.nil?
4446
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4447
+ execute_or_queue_command(command, &block)
4448
+ end
4449
+
4450
+ # Upgrade from basic site search to advanced site search.
4451
+ # @param [String] site_search_engine
4452
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
4453
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
4454
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
4455
+ # @param [String] fields
4456
+ # Selector specifying which fields to include in a partial response.
4457
+ # @param [String] quota_user
4458
+ # Available to use for quota purposes for server-side applications. Can be any
4459
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4460
+ # @param [Google::Apis::RequestOptions] options
4461
+ # Request-specific options
4462
+ #
4463
+ # @yield [result, err] Result & error if block supplied
4464
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4465
+ # @yieldparam err [StandardError] error object if request failed
4466
+ #
4467
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4468
+ #
4469
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4470
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4471
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4472
+ def enable_project_location_data_store_site_search_engine_advanced_site_search(site_search_engine, google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4473
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
4474
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest::Representation
4475
+ command.request_object = google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
4476
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4477
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4478
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
4479
+ command.query['fields'] = fields unless fields.nil?
4480
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4481
+ execute_or_queue_command(command, &block)
4482
+ end
4483
+
3678
4484
  # Request on-demand recrawl for a list of URIs.
3679
4485
  # @param [String] site_search_engine
3680
4486
  # Required. Full resource name of the SiteSearchEngine, such as `projects/*/
@@ -3709,6 +4515,228 @@ module Google
3709
4515
  execute_or_queue_command(command, &block)
3710
4516
  end
3711
4517
 
4518
+ # Creates TargetSite in a batch.
4519
+ # @param [String] parent
4520
+ # Required. The parent resource shared by all TargetSites being created. `
4521
+ # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
4522
+ # data_store`/siteSearchEngine`. The parent field in the CreateBookRequest
4523
+ # messages must either be empty or match this field.
4524
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest] google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object
4525
+ # @param [String] fields
4526
+ # Selector specifying which fields to include in a partial response.
4527
+ # @param [String] quota_user
4528
+ # Available to use for quota purposes for server-side applications. Can be any
4529
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4530
+ # @param [Google::Apis::RequestOptions] options
4531
+ # Request-specific options
4532
+ #
4533
+ # @yield [result, err] Result & error if block supplied
4534
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4535
+ # @yieldparam err [StandardError] error object if request failed
4536
+ #
4537
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4538
+ #
4539
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4540
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4541
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4542
+ def batch_project_location_data_store_site_search_engine_target_site_create(parent, google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4543
+ command = make_simple_command(:post, 'v1alpha/{+parent}/targetSites:batchCreate', options)
4544
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest::Representation
4545
+ command.request_object = google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object
4546
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4547
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4548
+ command.params['parent'] = parent unless parent.nil?
4549
+ command.query['fields'] = fields unless fields.nil?
4550
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4551
+ execute_or_queue_command(command, &block)
4552
+ end
4553
+
4554
+ # Creates a TargetSite.
4555
+ # @param [String] parent
4556
+ # Required. Parent resource name of TargetSite, such as `projects/`project`/
4557
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
4558
+ # siteSearchEngine`.
4559
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] google_cloud_discoveryengine_v1alpha_target_site_object
4560
+ # @param [String] fields
4561
+ # Selector specifying which fields to include in a partial response.
4562
+ # @param [String] quota_user
4563
+ # Available to use for quota purposes for server-side applications. Can be any
4564
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4565
+ # @param [Google::Apis::RequestOptions] options
4566
+ # Request-specific options
4567
+ #
4568
+ # @yield [result, err] Result & error if block supplied
4569
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4570
+ # @yieldparam err [StandardError] error object if request failed
4571
+ #
4572
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4573
+ #
4574
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4575
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4576
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4577
+ def create_project_location_data_store_site_search_engine_target_site(parent, google_cloud_discoveryengine_v1alpha_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4578
+ command = make_simple_command(:post, 'v1alpha/{+parent}/targetSites', options)
4579
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
4580
+ command.request_object = google_cloud_discoveryengine_v1alpha_target_site_object
4581
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4582
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4583
+ command.params['parent'] = parent unless parent.nil?
4584
+ command.query['fields'] = fields unless fields.nil?
4585
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4586
+ execute_or_queue_command(command, &block)
4587
+ end
4588
+
4589
+ # Deletes a TargetSite.
4590
+ # @param [String] name
4591
+ # Required. Full resource name of TargetSite, such as `projects/`project`/
4592
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
4593
+ # siteSearchEngine/targetSites/`target_site``. If the caller does not have
4594
+ # permission to access the TargetSite, regardless of whether or not it exists, a
4595
+ # PERMISSION_DENIED error is returned. If the requested TargetSite does not
4596
+ # exist, a NOT_FOUND error is returned.
4597
+ # @param [String] fields
4598
+ # Selector specifying which fields to include in a partial response.
4599
+ # @param [String] quota_user
4600
+ # Available to use for quota purposes for server-side applications. Can be any
4601
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4602
+ # @param [Google::Apis::RequestOptions] options
4603
+ # Request-specific options
4604
+ #
4605
+ # @yield [result, err] Result & error if block supplied
4606
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4607
+ # @yieldparam err [StandardError] error object if request failed
4608
+ #
4609
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4610
+ #
4611
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4612
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4613
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4614
+ def delete_project_location_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
4615
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
4616
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4617
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4618
+ command.params['name'] = name unless name.nil?
4619
+ command.query['fields'] = fields unless fields.nil?
4620
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4621
+ execute_or_queue_command(command, &block)
4622
+ end
4623
+
4624
+ # Gets a TargetSite.
4625
+ # @param [String] name
4626
+ # Required. Full resource name of TargetSite, such as `projects/`project`/
4627
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
4628
+ # siteSearchEngine/targetSites/`target_site``. If the caller does not have
4629
+ # permission to access the TargetSite, regardless of whether or not it exists, a
4630
+ # PERMISSION_DENIED error is returned. If the requested TargetSite does not
4631
+ # exist, a NOT_FOUND error is returned.
4632
+ # @param [String] fields
4633
+ # Selector specifying which fields to include in a partial response.
4634
+ # @param [String] quota_user
4635
+ # Available to use for quota purposes for server-side applications. Can be any
4636
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4637
+ # @param [Google::Apis::RequestOptions] options
4638
+ # Request-specific options
4639
+ #
4640
+ # @yield [result, err] Result & error if block supplied
4641
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] parsed result object
4642
+ # @yieldparam err [StandardError] error object if request failed
4643
+ #
4644
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite]
4645
+ #
4646
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4647
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4648
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4649
+ def get_project_location_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
4650
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4651
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
4652
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite
4653
+ command.params['name'] = name unless name.nil?
4654
+ command.query['fields'] = fields unless fields.nil?
4655
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4656
+ execute_or_queue_command(command, &block)
4657
+ end
4658
+
4659
+ # Gets a list of TargetSites.
4660
+ # @param [String] parent
4661
+ # Required. The parent site search engine resource name, such as `projects/`
4662
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
4663
+ # siteSearchEngine`. If the caller does not have permission to list TargetSites
4664
+ # under this site search engine, regardless of whether or not this branch exists,
4665
+ # a PERMISSION_DENIED error is returned.
4666
+ # @param [Fixnum] page_size
4667
+ # Requested page size. Server may return fewer items than requested. If
4668
+ # unspecified, server will pick an appropriate default. The maximum value is
4669
+ # 1000; values above 1000 will be coerced to 1000. If this field is negative, an
4670
+ # INVALID_ARGUMENT error is returned.
4671
+ # @param [String] page_token
4672
+ # A page token, received from a previous `ListTargetSites` call. Provide this to
4673
+ # retrieve the subsequent page. When paginating, all other parameters provided
4674
+ # to `ListTargetSites` must match the call that provided the page token.
4675
+ # @param [String] fields
4676
+ # Selector specifying which fields to include in a partial response.
4677
+ # @param [String] quota_user
4678
+ # Available to use for quota purposes for server-side applications. Can be any
4679
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4680
+ # @param [Google::Apis::RequestOptions] options
4681
+ # Request-specific options
4682
+ #
4683
+ # @yield [result, err] Result & error if block supplied
4684
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse] parsed result object
4685
+ # @yieldparam err [StandardError] error object if request failed
4686
+ #
4687
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse]
4688
+ #
4689
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4690
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4691
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4692
+ def list_project_location_data_store_site_search_engine_target_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4693
+ command = make_simple_command(:get, 'v1alpha/{+parent}/targetSites', options)
4694
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse::Representation
4695
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse
4696
+ command.params['parent'] = parent unless parent.nil?
4697
+ command.query['pageSize'] = page_size unless page_size.nil?
4698
+ command.query['pageToken'] = page_token unless page_token.nil?
4699
+ command.query['fields'] = fields unless fields.nil?
4700
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4701
+ execute_or_queue_command(command, &block)
4702
+ end
4703
+
4704
+ # Updates a TargetSite.
4705
+ # @param [String] name
4706
+ # Output only. The fully qualified resource name of the target site. `projects/`
4707
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
4708
+ # siteSearchEngine/targetSites/`target_site`` The `target_site_id` is system-
4709
+ # generated.
4710
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] google_cloud_discoveryengine_v1alpha_target_site_object
4711
+ # @param [String] fields
4712
+ # Selector specifying which fields to include in a partial response.
4713
+ # @param [String] quota_user
4714
+ # Available to use for quota purposes for server-side applications. Can be any
4715
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4716
+ # @param [Google::Apis::RequestOptions] options
4717
+ # Request-specific options
4718
+ #
4719
+ # @yield [result, err] Result & error if block supplied
4720
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4721
+ # @yieldparam err [StandardError] error object if request failed
4722
+ #
4723
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4724
+ #
4725
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4726
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4727
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4728
+ def patch_project_location_data_store_site_search_engine_target_site(name, google_cloud_discoveryengine_v1alpha_target_site_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4729
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
4730
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
4731
+ command.request_object = google_cloud_discoveryengine_v1alpha_target_site_object
4732
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4733
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4734
+ command.params['name'] = name unless name.nil?
4735
+ command.query['fields'] = fields unless fields.nil?
4736
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4737
+ execute_or_queue_command(command, &block)
4738
+ end
4739
+
3712
4740
  # Writes a single user event from the browser. This uses a GET request to due to
3713
4741
  # browser restriction of POST-ing to a third-party domain. This method is used
3714
4742
  # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.