google-apis-discoveryengine_v1alpha 0.27.0 → 0.29.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -190,6 +190,77 @@ module Google
190
190
  execute_or_queue_command(command, &block)
191
191
  end
192
192
 
193
+ # Gets the latest state of a long-running operation. Clients can use this method
194
+ # to poll the operation result at intervals as recommended by the API service.
195
+ # @param [String] name
196
+ # The name of the operation resource.
197
+ # @param [String] fields
198
+ # Selector specifying which fields to include in a partial response.
199
+ # @param [String] quota_user
200
+ # Available to use for quota purposes for server-side applications. Can be any
201
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
202
+ # @param [Google::Apis::RequestOptions] options
203
+ # Request-specific options
204
+ #
205
+ # @yield [result, err] Result & error if block supplied
206
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
207
+ # @yieldparam err [StandardError] error object if request failed
208
+ #
209
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
210
+ #
211
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
212
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
213
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
214
+ def get_project_location_collection_data_connector_operation(name, fields: nil, quota_user: nil, options: nil, &block)
215
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
216
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
217
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
218
+ command.params['name'] = name unless name.nil?
219
+ command.query['fields'] = fields unless fields.nil?
220
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
221
+ execute_or_queue_command(command, &block)
222
+ end
223
+
224
+ # Lists operations that match the specified filter in the request. If the server
225
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
226
+ # @param [String] name
227
+ # The name of the operation's parent resource.
228
+ # @param [String] filter
229
+ # The standard list filter.
230
+ # @param [Fixnum] page_size
231
+ # The standard list page size.
232
+ # @param [String] page_token
233
+ # The standard list page token.
234
+ # @param [String] fields
235
+ # Selector specifying which fields to include in a partial response.
236
+ # @param [String] quota_user
237
+ # Available to use for quota purposes for server-side applications. Can be any
238
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
239
+ # @param [Google::Apis::RequestOptions] options
240
+ # Request-specific options
241
+ #
242
+ # @yield [result, err] Result & error if block supplied
243
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
244
+ # @yieldparam err [StandardError] error object if request failed
245
+ #
246
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
247
+ #
248
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
249
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
250
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
251
+ def list_project_location_collection_data_connector_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
252
+ command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
253
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
254
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
255
+ command.params['name'] = name unless name.nil?
256
+ command.query['filter'] = filter unless filter.nil?
257
+ command.query['pageSize'] = page_size unless page_size.nil?
258
+ command.query['pageToken'] = page_token unless page_token.nil?
259
+ command.query['fields'] = fields unless fields.nil?
260
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
261
+ execute_or_queue_command(command, &block)
262
+ end
263
+
193
264
  # Completes the specified user input with keyword suggestions.
194
265
  # @param [String] data_store
195
266
  # Required. The parent data store resource name for which the completion is
@@ -368,6 +439,40 @@ module Google
368
439
  execute_or_queue_command(command, &block)
369
440
  end
370
441
 
442
+ # Gets the SiteSearchEngine.
443
+ # @param [String] name
444
+ # Required. Resource name of SiteSearchEngine, such as `projects/`project`/
445
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
446
+ # siteSearchEngine`. If the caller does not have permission to access the [
447
+ # SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED
448
+ # error is returned.
449
+ # @param [String] fields
450
+ # Selector specifying which fields to include in a partial response.
451
+ # @param [String] quota_user
452
+ # Available to use for quota purposes for server-side applications. Can be any
453
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
454
+ # @param [Google::Apis::RequestOptions] options
455
+ # Request-specific options
456
+ #
457
+ # @yield [result, err] Result & error if block supplied
458
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine] parsed result object
459
+ # @yieldparam err [StandardError] error object if request failed
460
+ #
461
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine]
462
+ #
463
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
464
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
465
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
466
+ def get_project_location_collection_data_store_site_search_engine(name, fields: nil, quota_user: nil, options: nil, &block)
467
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
468
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine::Representation
469
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
470
+ command.params['name'] = name unless name.nil?
471
+ command.query['fields'] = fields unless fields.nil?
472
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
473
+ execute_or_queue_command(command, &block)
474
+ end
475
+
371
476
  # Lists all the DataStores associated with the project.
372
477
  # @param [String] parent
373
478
  # Required. The parent branch resource name, such as `projects/`project`/
@@ -995,7 +1100,8 @@ module Google
995
1100
  # Conversation to update does not exist, a NOT_FOUND error is returned.
996
1101
  # @param [String] name
997
1102
  # Immutable. Fully qualified name `project/*/locations/global/collections/`
998
- # collection`/dataStore/*/conversations/*`
1103
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
1104
+ # collections/`collection`/engines/*/conversations/*`.
999
1105
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
1000
1106
  # @param [String] update_mask
1001
1107
  # Indicates which fields in the provided Conversation to update. The following
@@ -1509,11 +1615,47 @@ module Google
1509
1615
  execute_or_queue_command(command, &block)
1510
1616
  end
1511
1617
 
1512
- # Request on-demand recrawl for a list of URIs.
1618
+ # Verify target sites' ownership and validity. This API sends all the target
1619
+ # sites under site search engine for verification.
1620
+ # @param [String] parent
1621
+ # Required. The parent resource shared by all TargetSites being verified. `
1622
+ # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
1623
+ # data_store`/siteSearchEngine`.
1624
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest] google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object
1625
+ # @param [String] fields
1626
+ # Selector specifying which fields to include in a partial response.
1627
+ # @param [String] quota_user
1628
+ # Available to use for quota purposes for server-side applications. Can be any
1629
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1630
+ # @param [Google::Apis::RequestOptions] options
1631
+ # Request-specific options
1632
+ #
1633
+ # @yield [result, err] Result & error if block supplied
1634
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
1635
+ # @yieldparam err [StandardError] error object if request failed
1636
+ #
1637
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
1638
+ #
1639
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1640
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1641
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1642
+ 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)
1643
+ command = make_simple_command(:post, 'v1alpha/{+parent}:batchVerifyTargetSites', options)
1644
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest::Representation
1645
+ command.request_object = google_cloud_discoveryengine_v1alpha_batch_verify_target_sites_request_object
1646
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1647
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1648
+ command.params['parent'] = parent unless parent.nil?
1649
+ command.query['fields'] = fields unless fields.nil?
1650
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1651
+ execute_or_queue_command(command, &block)
1652
+ end
1653
+
1654
+ # Downgrade from advanced site search to basic site search.
1513
1655
  # @param [String] site_search_engine
1514
- # Required. Full resource name of the SiteSearchEngine, such as `projects/*/
1515
- # locations/*/collections/*/dataStores/*/siteSearchEngine`.
1516
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest] google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
1656
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
1657
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
1658
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
1517
1659
  # @param [String] fields
1518
1660
  # Selector specifying which fields to include in a partial response.
1519
1661
  # @param [String] quota_user
@@ -1531,10 +1673,10 @@ module Google
1531
1673
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1532
1674
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1533
1675
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1534
- 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)
1535
- command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:recrawlUris', options)
1536
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest::Representation
1537
- command.request_object = google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
1676
+ 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)
1677
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
1678
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest::Representation
1679
+ command.request_object = google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
1538
1680
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1539
1681
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1540
1682
  command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
@@ -1543,10 +1685,11 @@ module Google
1543
1685
  execute_or_queue_command(command, &block)
1544
1686
  end
1545
1687
 
1546
- # Gets the latest state of a long-running operation. Clients can use this method
1547
- # to poll the operation result at intervals as recommended by the API service.
1548
- # @param [String] name
1549
- # The name of the operation resource.
1688
+ # Upgrade from basic site search to advanced site search.
1689
+ # @param [String] site_search_engine
1690
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
1691
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
1692
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
1550
1693
  # @param [String] fields
1551
1694
  # Selector specifying which fields to include in a partial response.
1552
1695
  # @param [String] quota_user
@@ -1564,26 +1707,34 @@ module Google
1564
1707
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1565
1708
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1566
1709
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1567
- def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1568
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
1710
+ 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)
1711
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
1712
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest::Representation
1713
+ command.request_object = google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
1569
1714
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1570
1715
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1571
- command.params['name'] = name unless name.nil?
1716
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
1572
1717
  command.query['fields'] = fields unless fields.nil?
1573
1718
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1574
1719
  execute_or_queue_command(command, &block)
1575
1720
  end
1576
1721
 
1577
- # Lists operations that match the specified filter in the request. If the server
1578
- # doesn't support this method, it returns `UNIMPLEMENTED`.
1579
- # @param [String] name
1580
- # The name of the operation's parent resource.
1581
- # @param [String] filter
1582
- # The standard list filter.
1722
+ # Returns list of target sites with its domain verification status. This method
1723
+ # can only be called under data store with BASIC_SITE_SEARCH state at the moment.
1724
+ # @param [String] site_search_engine
1725
+ # Required. The site search engine resource under which we fetch all the domain
1726
+ # verification status. `projects/`project`/locations/`location`/collections/`
1727
+ # collection`/dataStores/`data_store`/siteSearchEngine`.
1583
1728
  # @param [Fixnum] page_size
1584
- # The standard list page size.
1729
+ # Requested page size. Server may return fewer items than requested. If
1730
+ # unspecified, server will pick an appropriate default. The maximum value is
1731
+ # 1000; values above 1000 will be coerced to 1000. If this field is negative, an
1732
+ # INVALID_ARGUMENT error is returned.
1585
1733
  # @param [String] page_token
1586
- # The standard list page token.
1734
+ # A page token, received from a previous `FetchDomainVerificationStatus` call.
1735
+ # Provide this to retrieve the subsequent page. When paginating, all other
1736
+ # parameters provided to `FetchDomainVerificationStatus` must match the call
1737
+ # that provided the page token.
1587
1738
  # @param [String] fields
1588
1739
  # Selector specifying which fields to include in a partial response.
1589
1740
  # @param [String] quota_user
@@ -1593,20 +1744,19 @@ module Google
1593
1744
  # Request-specific options
1594
1745
  #
1595
1746
  # @yield [result, err] Result & error if block supplied
1596
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
1747
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse] parsed result object
1597
1748
  # @yieldparam err [StandardError] error object if request failed
1598
1749
  #
1599
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
1750
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse]
1600
1751
  #
1601
1752
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1602
1753
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1603
1754
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1604
- 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)
1605
- command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
1606
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
1607
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
1608
- command.params['name'] = name unless name.nil?
1609
- command.query['filter'] = filter unless filter.nil?
1755
+ 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)
1756
+ command = make_simple_command(:get, 'v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus', options)
1757
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse::Representation
1758
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
1759
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
1610
1760
  command.query['pageSize'] = page_size unless page_size.nil?
1611
1761
  command.query['pageToken'] = page_token unless page_token.nil?
1612
1762
  command.query['fields'] = fields unless fields.nil?
@@ -1614,6 +1764,40 @@ module Google
1614
1764
  execute_or_queue_command(command, &block)
1615
1765
  end
1616
1766
 
1767
+ # Request on-demand recrawl for a list of URIs.
1768
+ # @param [String] site_search_engine
1769
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/*/
1770
+ # locations/*/collections/*/dataStores/*/siteSearchEngine`.
1771
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest] google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
1772
+ # @param [String] fields
1773
+ # Selector specifying which fields to include in a partial response.
1774
+ # @param [String] quota_user
1775
+ # Available to use for quota purposes for server-side applications. Can be any
1776
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1777
+ # @param [Google::Apis::RequestOptions] options
1778
+ # Request-specific options
1779
+ #
1780
+ # @yield [result, err] Result & error if block supplied
1781
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
1782
+ # @yieldparam err [StandardError] error object if request failed
1783
+ #
1784
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
1785
+ #
1786
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1787
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1788
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1789
+ 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)
1790
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:recrawlUris', options)
1791
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest::Representation
1792
+ command.request_object = google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
1793
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1794
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1795
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
1796
+ command.query['fields'] = fields unless fields.nil?
1797
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1798
+ execute_or_queue_command(command, &block)
1799
+ end
1800
+
1617
1801
  # Gets the latest state of a long-running operation. Clients can use this method
1618
1802
  # to poll the operation result at intervals as recommended by the API service.
1619
1803
  # @param [String] name
@@ -1635,7 +1819,7 @@ module Google
1635
1819
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1636
1820
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1637
1821
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1638
- def get_project_location_collection_data_store_site_search_engine_target_site_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1822
+ def get_project_location_collection_data_store_site_search_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1639
1823
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
1640
1824
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1641
1825
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
@@ -1672,7 +1856,7 @@ module Google
1672
1856
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1673
1857
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1674
1858
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1675
- 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)
1859
+ 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
1860
  command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
1677
1861
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
1678
1862
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
@@ -1685,24 +1869,13 @@ module Google
1685
1869
  execute_or_queue_command(command, &block)
1686
1870
  end
1687
1871
 
1688
- # Writes a single user event from the browser. This uses a GET request to due to
1689
- # browser restriction of POST-ing to a third-party domain. This method is used
1690
- # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
1691
- # Users should not call this method directly.
1872
+ # Creates TargetSite in a batch.
1692
1873
  # @param [String] parent
1693
- # Required. The parent DataStore resource name, such as `projects/`project`/
1694
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
1695
- # @param [Fixnum] ets
1696
- # The event timestamp in milliseconds. This prevents browser caching of
1697
- # otherwise identical get requests. The name is abbreviated to reduce the
1698
- # payload bytes.
1699
- # @param [String] uri
1700
- # The URL including cgi-parameters but excluding the hash fragment with a length
1701
- # limit of 5,000 characters. This is often more useful than the referer URL,
1702
- # because many browsers only send the domain for third-party requests.
1703
- # @param [String] user_event
1704
- # Required. URL encoded UserEvent proto with a length limit of 2,000,000
1705
- # characters.
1874
+ # Required. The parent resource shared by all TargetSites being created. `
1875
+ # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
1876
+ # data_store`/siteSearchEngine`. The parent field in the CreateBookRequest
1877
+ # messages must either be empty or match this field.
1878
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest] google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object
1706
1879
  # @param [String] fields
1707
1880
  # Selector specifying which fields to include in a partial response.
1708
1881
  # @param [String] quota_user
@@ -1712,36 +1885,32 @@ module Google
1712
1885
  # Request-specific options
1713
1886
  #
1714
1887
  # @yield [result, err] Result & error if block supplied
1715
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody] parsed result object
1888
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
1716
1889
  # @yieldparam err [StandardError] error object if request failed
1717
1890
  #
1718
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody]
1891
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
1719
1892
  #
1720
1893
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1721
1894
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1722
1895
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1723
- 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)
1724
- command = make_simple_command(:get, 'v1alpha/{+parent}/userEvents:collect', options)
1725
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody::Representation
1726
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody
1896
+ 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)
1897
+ command = make_simple_command(:post, 'v1alpha/{+parent}/targetSites:batchCreate', options)
1898
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest::Representation
1899
+ command.request_object = google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object
1900
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1901
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1727
1902
  command.params['parent'] = parent unless parent.nil?
1728
- command.query['ets'] = ets unless ets.nil?
1729
- command.query['uri'] = uri unless uri.nil?
1730
- command.query['userEvent'] = user_event unless user_event.nil?
1731
1903
  command.query['fields'] = fields unless fields.nil?
1732
1904
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1733
1905
  execute_or_queue_command(command, &block)
1734
1906
  end
1735
1907
 
1736
- # Bulk import of User events. Request processing might be synchronous. Events
1737
- # that already exist are skipped. Use this method for backfilling historical
1738
- # user events. Operation.response is of type ImportResponse. Note that it is
1739
- # possible for a subset of the items to be successfully inserted. Operation.
1740
- # metadata is of type ImportMetadata.
1908
+ # Creates a TargetSite.
1741
1909
  # @param [String] parent
1742
- # Required. Parent DataStore resource name, of the form `projects/`project`/
1743
- # locations/`location`/collections/`collection`/dataStores/`data_store``
1744
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest] google_cloud_discoveryengine_v1alpha_import_user_events_request_object
1910
+ # Required. Parent resource name of TargetSite, such as `projects/`project`/
1911
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
1912
+ # siteSearchEngine`.
1913
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] google_cloud_discoveryengine_v1alpha_target_site_object
1745
1914
  # @param [String] fields
1746
1915
  # Selector specifying which fields to include in a partial response.
1747
1916
  # @param [String] quota_user
@@ -1759,10 +1928,10 @@ module Google
1759
1928
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1760
1929
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1761
1930
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1762
- 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)
1763
- command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:import', options)
1764
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest::Representation
1765
- command.request_object = google_cloud_discoveryengine_v1alpha_import_user_events_request_object
1931
+ 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)
1932
+ command = make_simple_command(:post, 'v1alpha/{+parent}/targetSites', options)
1933
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
1934
+ command.request_object = google_cloud_discoveryengine_v1alpha_target_site_object
1766
1935
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1767
1936
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1768
1937
  command.params['parent'] = parent unless parent.nil?
@@ -1771,15 +1940,14 @@ module Google
1771
1940
  execute_or_queue_command(command, &block)
1772
1941
  end
1773
1942
 
1774
- # Deletes permanently all user events specified by the filter provided.
1775
- # Depending on the number of events specified by the filter, this operation
1776
- # could take hours or days to complete. To test a filter, use the list command
1777
- # first.
1778
- # @param [String] parent
1779
- # Required. The resource name of the catalog under which the events are created.
1780
- # The format is `projects/$`projectId`/locations/global/collections/`$
1781
- # collectionId`/dataStores/$`dataStoreId``
1782
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest] google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
1943
+ # Deletes a TargetSite.
1944
+ # @param [String] name
1945
+ # Required. Full resource name of TargetSite, such as `projects/`project`/
1946
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
1947
+ # siteSearchEngine/targetSites/`target_site``. If the caller does not have
1948
+ # permission to access the TargetSite, regardless of whether or not it exists, a
1949
+ # PERMISSION_DENIED error is returned. If the requested TargetSite does not
1950
+ # exist, a NOT_FOUND error is returned.
1783
1951
  # @param [String] fields
1784
1952
  # Selector specifying which fields to include in a partial response.
1785
1953
  # @param [String] quota_user
@@ -1797,23 +1965,332 @@ module Google
1797
1965
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1798
1966
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1799
1967
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1800
- 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)
1801
- command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:purge', options)
1802
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest::Representation
1803
- command.request_object = google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
1968
+ def delete_project_location_collection_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
1969
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1804
1970
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1805
1971
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1806
- command.params['parent'] = parent unless parent.nil?
1972
+ command.params['name'] = name unless name.nil?
1807
1973
  command.query['fields'] = fields unless fields.nil?
1808
1974
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1809
1975
  execute_or_queue_command(command, &block)
1810
1976
  end
1811
1977
 
1812
- # Writes a single user event.
1813
- # @param [String] parent
1814
- # Required. The parent DataStore resource name, such as `projects/`project`/
1815
- # locations/`location`/collections/`collection`/dataStores/`data_store``.
1816
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
1978
+ # Gets a TargetSite.
1979
+ # @param [String] name
1980
+ # Required. Full resource name of TargetSite, such as `projects/`project`/
1981
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
1982
+ # siteSearchEngine/targetSites/`target_site``. If the caller does not have
1983
+ # permission to access the TargetSite, regardless of whether or not it exists, a
1984
+ # PERMISSION_DENIED error is returned. If the requested TargetSite does not
1985
+ # exist, a NOT_FOUND error is returned.
1986
+ # @param [String] fields
1987
+ # Selector specifying which fields to include in a partial response.
1988
+ # @param [String] quota_user
1989
+ # Available to use for quota purposes for server-side applications. Can be any
1990
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1991
+ # @param [Google::Apis::RequestOptions] options
1992
+ # Request-specific options
1993
+ #
1994
+ # @yield [result, err] Result & error if block supplied
1995
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] parsed result object
1996
+ # @yieldparam err [StandardError] error object if request failed
1997
+ #
1998
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite]
1999
+ #
2000
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2001
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2002
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2003
+ def get_project_location_collection_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
2004
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2005
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
2006
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite
2007
+ command.params['name'] = name unless name.nil?
2008
+ command.query['fields'] = fields unless fields.nil?
2009
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2010
+ execute_or_queue_command(command, &block)
2011
+ end
2012
+
2013
+ # Gets a list of TargetSites.
2014
+ # @param [String] parent
2015
+ # Required. The parent site search engine resource name, such as `projects/`
2016
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
2017
+ # siteSearchEngine`. If the caller does not have permission to list TargetSites
2018
+ # under this site search engine, regardless of whether or not this branch exists,
2019
+ # a PERMISSION_DENIED error is returned.
2020
+ # @param [Fixnum] page_size
2021
+ # Requested page size. Server may return fewer items than requested. If
2022
+ # unspecified, server will pick an appropriate default. The maximum value is
2023
+ # 1000; values above 1000 will be coerced to 1000. If this field is negative, an
2024
+ # INVALID_ARGUMENT error is returned.
2025
+ # @param [String] page_token
2026
+ # A page token, received from a previous `ListTargetSites` call. Provide this to
2027
+ # retrieve the subsequent page. When paginating, all other parameters provided
2028
+ # to `ListTargetSites` must match the call that provided the page token.
2029
+ # @param [String] fields
2030
+ # Selector specifying which fields to include in a partial response.
2031
+ # @param [String] quota_user
2032
+ # Available to use for quota purposes for server-side applications. Can be any
2033
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2034
+ # @param [Google::Apis::RequestOptions] options
2035
+ # Request-specific options
2036
+ #
2037
+ # @yield [result, err] Result & error if block supplied
2038
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse] parsed result object
2039
+ # @yieldparam err [StandardError] error object if request failed
2040
+ #
2041
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse]
2042
+ #
2043
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2044
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2045
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2046
+ 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)
2047
+ command = make_simple_command(:get, 'v1alpha/{+parent}/targetSites', options)
2048
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse::Representation
2049
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse
2050
+ command.params['parent'] = parent unless parent.nil?
2051
+ command.query['pageSize'] = page_size unless page_size.nil?
2052
+ command.query['pageToken'] = page_token unless page_token.nil?
2053
+ command.query['fields'] = fields unless fields.nil?
2054
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2055
+ execute_or_queue_command(command, &block)
2056
+ end
2057
+
2058
+ # Updates a TargetSite.
2059
+ # @param [String] name
2060
+ # Output only. The fully qualified resource name of the target site. `projects/`
2061
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
2062
+ # siteSearchEngine/targetSites/`target_site`` The `target_site_id` is system-
2063
+ # generated.
2064
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] google_cloud_discoveryengine_v1alpha_target_site_object
2065
+ # @param [String] fields
2066
+ # Selector specifying which fields to include in a partial response.
2067
+ # @param [String] quota_user
2068
+ # Available to use for quota purposes for server-side applications. Can be any
2069
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2070
+ # @param [Google::Apis::RequestOptions] options
2071
+ # Request-specific options
2072
+ #
2073
+ # @yield [result, err] Result & error if block supplied
2074
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2075
+ # @yieldparam err [StandardError] error object if request failed
2076
+ #
2077
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2078
+ #
2079
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2080
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2081
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2082
+ 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)
2083
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2084
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
2085
+ command.request_object = google_cloud_discoveryengine_v1alpha_target_site_object
2086
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2087
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2088
+ command.params['name'] = name unless name.nil?
2089
+ command.query['fields'] = fields unless fields.nil?
2090
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2091
+ execute_or_queue_command(command, &block)
2092
+ end
2093
+
2094
+ # Gets the latest state of a long-running operation. Clients can use this method
2095
+ # to poll the operation result at intervals as recommended by the API service.
2096
+ # @param [String] name
2097
+ # The name of the operation resource.
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::GoogleLongrunningOperation] parsed result object
2108
+ # @yieldparam err [StandardError] error object if request failed
2109
+ #
2110
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
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 get_project_location_collection_data_store_site_search_engine_target_site_operation(name, fields: nil, quota_user: nil, options: nil, &block)
2116
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2117
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2118
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2119
+ command.params['name'] = name unless name.nil?
2120
+ command.query['fields'] = fields unless fields.nil?
2121
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2122
+ execute_or_queue_command(command, &block)
2123
+ end
2124
+
2125
+ # Lists operations that match the specified filter in the request. If the server
2126
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
2127
+ # @param [String] name
2128
+ # The name of the operation's parent resource.
2129
+ # @param [String] filter
2130
+ # The standard list filter.
2131
+ # @param [Fixnum] page_size
2132
+ # The standard list page size.
2133
+ # @param [String] page_token
2134
+ # The standard list page token.
2135
+ # @param [String] fields
2136
+ # Selector specifying which fields to include in a partial response.
2137
+ # @param [String] quota_user
2138
+ # Available to use for quota purposes for server-side applications. Can be any
2139
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2140
+ # @param [Google::Apis::RequestOptions] options
2141
+ # Request-specific options
2142
+ #
2143
+ # @yield [result, err] Result & error if block supplied
2144
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
2145
+ # @yieldparam err [StandardError] error object if request failed
2146
+ #
2147
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
2148
+ #
2149
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2150
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2151
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2152
+ 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)
2153
+ command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
2154
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
2155
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
2156
+ command.params['name'] = name unless name.nil?
2157
+ command.query['filter'] = filter unless filter.nil?
2158
+ command.query['pageSize'] = page_size unless page_size.nil?
2159
+ command.query['pageToken'] = page_token unless page_token.nil?
2160
+ command.query['fields'] = fields unless fields.nil?
2161
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2162
+ execute_or_queue_command(command, &block)
2163
+ end
2164
+
2165
+ # Writes a single user event from the browser. This uses a GET request to due to
2166
+ # browser restriction of POST-ing to a third-party domain. This method is used
2167
+ # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
2168
+ # Users should not call this method directly.
2169
+ # @param [String] parent
2170
+ # Required. The parent DataStore resource name, such as `projects/`project`/
2171
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
2172
+ # @param [Fixnum] ets
2173
+ # The event timestamp in milliseconds. This prevents browser caching of
2174
+ # otherwise identical get requests. The name is abbreviated to reduce the
2175
+ # payload bytes.
2176
+ # @param [String] uri
2177
+ # The URL including cgi-parameters but excluding the hash fragment with a length
2178
+ # limit of 5,000 characters. This is often more useful than the referer URL,
2179
+ # because many browsers only send the domain for third-party requests.
2180
+ # @param [String] user_event
2181
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
2182
+ # characters.
2183
+ # @param [String] fields
2184
+ # Selector specifying which fields to include in a partial response.
2185
+ # @param [String] quota_user
2186
+ # Available to use for quota purposes for server-side applications. Can be any
2187
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2188
+ # @param [Google::Apis::RequestOptions] options
2189
+ # Request-specific options
2190
+ #
2191
+ # @yield [result, err] Result & error if block supplied
2192
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody] parsed result object
2193
+ # @yieldparam err [StandardError] error object if request failed
2194
+ #
2195
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody]
2196
+ #
2197
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2198
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2199
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2200
+ 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)
2201
+ command = make_simple_command(:get, 'v1alpha/{+parent}/userEvents:collect', options)
2202
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody::Representation
2203
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody
2204
+ command.params['parent'] = parent unless parent.nil?
2205
+ command.query['ets'] = ets unless ets.nil?
2206
+ command.query['uri'] = uri unless uri.nil?
2207
+ command.query['userEvent'] = user_event unless user_event.nil?
2208
+ command.query['fields'] = fields unless fields.nil?
2209
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2210
+ execute_or_queue_command(command, &block)
2211
+ end
2212
+
2213
+ # Bulk import of User events. Request processing might be synchronous. Events
2214
+ # that already exist are skipped. Use this method for backfilling historical
2215
+ # user events. Operation.response is of type ImportResponse. Note that it is
2216
+ # possible for a subset of the items to be successfully inserted. Operation.
2217
+ # metadata is of type ImportMetadata.
2218
+ # @param [String] parent
2219
+ # Required. Parent DataStore resource name, of the form `projects/`project`/
2220
+ # locations/`location`/collections/`collection`/dataStores/`data_store``
2221
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest] google_cloud_discoveryengine_v1alpha_import_user_events_request_object
2222
+ # @param [String] fields
2223
+ # Selector specifying which fields to include in a partial response.
2224
+ # @param [String] quota_user
2225
+ # Available to use for quota purposes for server-side applications. Can be any
2226
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2227
+ # @param [Google::Apis::RequestOptions] options
2228
+ # Request-specific options
2229
+ #
2230
+ # @yield [result, err] Result & error if block supplied
2231
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2232
+ # @yieldparam err [StandardError] error object if request failed
2233
+ #
2234
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2235
+ #
2236
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2237
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2238
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2239
+ 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)
2240
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:import', options)
2241
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest::Representation
2242
+ command.request_object = google_cloud_discoveryengine_v1alpha_import_user_events_request_object
2243
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2244
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2245
+ command.params['parent'] = parent unless parent.nil?
2246
+ command.query['fields'] = fields unless fields.nil?
2247
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2248
+ execute_or_queue_command(command, &block)
2249
+ end
2250
+
2251
+ # Deletes permanently all user events specified by the filter provided.
2252
+ # Depending on the number of events specified by the filter, this operation
2253
+ # could take hours or days to complete. To test a filter, use the list command
2254
+ # first.
2255
+ # @param [String] parent
2256
+ # Required. The resource name of the catalog under which the events are created.
2257
+ # The format is `projects/$`projectId`/locations/global/collections/`$
2258
+ # collectionId`/dataStores/$`dataStoreId``
2259
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest] google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
2260
+ # @param [String] fields
2261
+ # Selector specifying which fields to include in a partial response.
2262
+ # @param [String] quota_user
2263
+ # Available to use for quota purposes for server-side applications. Can be any
2264
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2265
+ # @param [Google::Apis::RequestOptions] options
2266
+ # Request-specific options
2267
+ #
2268
+ # @yield [result, err] Result & error if block supplied
2269
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2270
+ # @yieldparam err [StandardError] error object if request failed
2271
+ #
2272
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2273
+ #
2274
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2275
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2276
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2277
+ 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)
2278
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:purge', options)
2279
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest::Representation
2280
+ command.request_object = google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
2281
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2282
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2283
+ command.params['parent'] = parent unless parent.nil?
2284
+ command.query['fields'] = fields unless fields.nil?
2285
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2286
+ execute_or_queue_command(command, &block)
2287
+ end
2288
+
2289
+ # Writes a single user event.
2290
+ # @param [String] parent
2291
+ # Required. The parent DataStore resource name, such as `projects/`project`/
2292
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
2293
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
1817
2294
  # @param [String] fields
1818
2295
  # Selector specifying which fields to include in a partial response.
1819
2296
  # @param [String] quota_user
@@ -1899,18 +2376,18 @@ module Google
1899
2376
  # Request-specific options
1900
2377
  #
1901
2378
  # @yield [result, err] Result & error if block supplied
1902
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
2379
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
1903
2380
  # @yieldparam err [StandardError] error object if request failed
1904
2381
  #
1905
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
2382
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
1906
2383
  #
1907
2384
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1908
2385
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1909
2386
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1910
2387
  def delete_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil, &block)
1911
2388
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1912
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
1913
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
2389
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2390
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1914
2391
  command.params['name'] = name unless name.nil?
1915
2392
  command.query['fields'] = fields unless fields.nil?
1916
2393
  command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -2116,21 +2593,249 @@ module Google
2116
2593
  # Request-specific options
2117
2594
  #
2118
2595
  # @yield [result, err] Result & error if block supplied
2119
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2596
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2597
+ # @yieldparam err [StandardError] error object if request failed
2598
+ #
2599
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2600
+ #
2601
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2602
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2603
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2604
+ def tune_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_tune_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2605
+ command = make_simple_command(:post, 'v1alpha/{+name}:tune', options)
2606
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest::Representation
2607
+ command.request_object = google_cloud_discoveryengine_v1alpha_tune_engine_request_object
2608
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2609
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2610
+ command.params['name'] = name unless name.nil?
2611
+ command.query['fields'] = fields unless fields.nil?
2612
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2613
+ execute_or_queue_command(command, &block)
2614
+ end
2615
+
2616
+ # Converses a conversation.
2617
+ # @param [String] name
2618
+ # Required. The resource name of the Conversation to get. Format: `projects/`
2619
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2620
+ # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
2621
+ # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
2622
+ # conversations/-` to activate auto session mode, which automatically creates a
2623
+ # new conversation inside a ConverseConversation session.
2624
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest] google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
2625
+ # @param [String] fields
2626
+ # Selector specifying which fields to include in a partial response.
2627
+ # @param [String] quota_user
2628
+ # Available to use for quota purposes for server-side applications. Can be any
2629
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2630
+ # @param [Google::Apis::RequestOptions] options
2631
+ # Request-specific options
2632
+ #
2633
+ # @yield [result, err] Result & error if block supplied
2634
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse] parsed result object
2635
+ # @yieldparam err [StandardError] error object if request failed
2636
+ #
2637
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse]
2638
+ #
2639
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2640
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2641
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2642
+ 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)
2643
+ command = make_simple_command(:post, 'v1alpha/{+name}:converse', options)
2644
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest::Representation
2645
+ command.request_object = google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
2646
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse::Representation
2647
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse
2648
+ command.params['name'] = name unless name.nil?
2649
+ command.query['fields'] = fields unless fields.nil?
2650
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2651
+ execute_or_queue_command(command, &block)
2652
+ end
2653
+
2654
+ # Creates a Conversation. If the Conversation to create already exists, an
2655
+ # ALREADY_EXISTS error is returned.
2656
+ # @param [String] parent
2657
+ # Required. Full resource name of parent data store. Format: `projects/`
2658
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2659
+ # data_store_id``
2660
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
2661
+ # @param [String] fields
2662
+ # Selector specifying which fields to include in a partial response.
2663
+ # @param [String] quota_user
2664
+ # Available to use for quota purposes for server-side applications. Can be any
2665
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2666
+ # @param [Google::Apis::RequestOptions] options
2667
+ # Request-specific options
2668
+ #
2669
+ # @yield [result, err] Result & error if block supplied
2670
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
2671
+ # @yieldparam err [StandardError] error object if request failed
2672
+ #
2673
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
2674
+ #
2675
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2676
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2677
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2678
+ def create_project_location_collection_engine_conversation(parent, google_cloud_discoveryengine_v1alpha_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2679
+ command = make_simple_command(:post, 'v1alpha/{+parent}/conversations', options)
2680
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
2681
+ command.request_object = google_cloud_discoveryengine_v1alpha_conversation_object
2682
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
2683
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
2684
+ command.params['parent'] = parent unless parent.nil?
2685
+ command.query['fields'] = fields unless fields.nil?
2686
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2687
+ execute_or_queue_command(command, &block)
2688
+ end
2689
+
2690
+ # Deletes a Conversation. If the Conversation to delete does not exist, a
2691
+ # NOT_FOUND error is returned.
2692
+ # @param [String] name
2693
+ # Required. The resource name of the Conversation to delete. Format: `projects/`
2694
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2695
+ # data_store_id`/conversations/`conversation_id``
2696
+ # @param [String] fields
2697
+ # Selector specifying which fields to include in a partial response.
2698
+ # @param [String] quota_user
2699
+ # Available to use for quota purposes for server-side applications. Can be any
2700
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2701
+ # @param [Google::Apis::RequestOptions] options
2702
+ # Request-specific options
2703
+ #
2704
+ # @yield [result, err] Result & error if block supplied
2705
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
2706
+ # @yieldparam err [StandardError] error object if request failed
2707
+ #
2708
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
2709
+ #
2710
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2711
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2712
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2713
+ def delete_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
2714
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
2715
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
2716
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
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
+ # Gets a Conversation.
2724
+ # @param [String] name
2725
+ # Required. The resource name of the Conversation to get. Format: `projects/`
2726
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2727
+ # data_store_id`/conversations/`conversation_id``
2728
+ # @param [String] fields
2729
+ # Selector specifying which fields to include in a partial response.
2730
+ # @param [String] quota_user
2731
+ # Available to use for quota purposes for server-side applications. Can be any
2732
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2733
+ # @param [Google::Apis::RequestOptions] options
2734
+ # Request-specific options
2735
+ #
2736
+ # @yield [result, err] Result & error if block supplied
2737
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
2738
+ # @yieldparam err [StandardError] error object if request failed
2739
+ #
2740
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
2741
+ #
2742
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2743
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2744
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2745
+ def get_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
2746
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2747
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
2748
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
2749
+ command.params['name'] = name unless name.nil?
2750
+ command.query['fields'] = fields unless fields.nil?
2751
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2752
+ execute_or_queue_command(command, &block)
2753
+ end
2754
+
2755
+ # Lists all Conversations by their parent DataStore.
2756
+ # @param [String] parent
2757
+ # Required. The data store resource name. Format: `projects/`project_number`/
2758
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
2759
+ # @param [String] filter
2760
+ # A filter to apply on the list results. The supported features are:
2761
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
2762
+ # @param [String] order_by
2763
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
2764
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
2765
+ # create_time` * `conversation_name` Example: "update_time desc" "create_time"
2766
+ # @param [Fixnum] page_size
2767
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
2768
+ # allowed value is 1000.
2769
+ # @param [String] page_token
2770
+ # A page token, received from a previous `ListConversations` call. Provide this
2771
+ # to retrieve the subsequent page.
2772
+ # @param [String] fields
2773
+ # Selector specifying which fields to include in a partial response.
2774
+ # @param [String] quota_user
2775
+ # Available to use for quota purposes for server-side applications. Can be any
2776
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2777
+ # @param [Google::Apis::RequestOptions] options
2778
+ # Request-specific options
2779
+ #
2780
+ # @yield [result, err] Result & error if block supplied
2781
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse] parsed result object
2782
+ # @yieldparam err [StandardError] error object if request failed
2783
+ #
2784
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse]
2785
+ #
2786
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2787
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2788
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2789
+ 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)
2790
+ command = make_simple_command(:get, 'v1alpha/{+parent}/conversations', options)
2791
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse::Representation
2792
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConversationsResponse
2793
+ command.params['parent'] = parent unless parent.nil?
2794
+ command.query['filter'] = filter unless filter.nil?
2795
+ command.query['orderBy'] = order_by unless order_by.nil?
2796
+ command.query['pageSize'] = page_size unless page_size.nil?
2797
+ command.query['pageToken'] = page_token unless page_token.nil?
2798
+ command.query['fields'] = fields unless fields.nil?
2799
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2800
+ execute_or_queue_command(command, &block)
2801
+ end
2802
+
2803
+ # Updates a Conversation. Conversation action type cannot be changed. If the
2804
+ # Conversation to update does not exist, a NOT_FOUND error is returned.
2805
+ # @param [String] name
2806
+ # Immutable. Fully qualified name `project/*/locations/global/collections/`
2807
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
2808
+ # collections/`collection`/engines/*/conversations/*`.
2809
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
2810
+ # @param [String] update_mask
2811
+ # Indicates which fields in the provided Conversation to update. The following
2812
+ # are NOT supported: * conversation.name If not set or empty, all supported
2813
+ # fields are updated.
2814
+ # @param [String] fields
2815
+ # Selector specifying which fields to include in a partial response.
2816
+ # @param [String] quota_user
2817
+ # Available to use for quota purposes for server-side applications. Can be any
2818
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2819
+ # @param [Google::Apis::RequestOptions] options
2820
+ # Request-specific options
2821
+ #
2822
+ # @yield [result, err] Result & error if block supplied
2823
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] parsed result object
2120
2824
  # @yieldparam err [StandardError] error object if request failed
2121
2825
  #
2122
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2826
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
2123
2827
  #
2124
2828
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2125
2829
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2126
2830
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2127
- def tune_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_tune_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2128
- command = make_simple_command(:post, 'v1alpha/{+name}:tune', options)
2129
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest::Representation
2130
- command.request_object = google_cloud_discoveryengine_v1alpha_tune_engine_request_object
2131
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2132
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2831
+ 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)
2832
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2833
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
2834
+ command.request_object = google_cloud_discoveryengine_v1alpha_conversation_object
2835
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
2836
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
2133
2837
  command.params['name'] = name unless name.nil?
2838
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2134
2839
  command.query['fields'] = fields unless fields.nil?
2135
2840
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2136
2841
  execute_or_queue_command(command, &block)
@@ -2534,6 +3239,40 @@ module Google
2534
3239
  execute_or_queue_command(command, &block)
2535
3240
  end
2536
3241
 
3242
+ # Gets the SiteSearchEngine.
3243
+ # @param [String] name
3244
+ # Required. Resource name of SiteSearchEngine, such as `projects/`project`/
3245
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
3246
+ # siteSearchEngine`. If the caller does not have permission to access the [
3247
+ # SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED
3248
+ # error is returned.
3249
+ # @param [String] fields
3250
+ # Selector specifying which fields to include in a partial response.
3251
+ # @param [String] quota_user
3252
+ # Available to use for quota purposes for server-side applications. Can be any
3253
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3254
+ # @param [Google::Apis::RequestOptions] options
3255
+ # Request-specific options
3256
+ #
3257
+ # @yield [result, err] Result & error if block supplied
3258
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine] parsed result object
3259
+ # @yieldparam err [StandardError] error object if request failed
3260
+ #
3261
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine]
3262
+ #
3263
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3264
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3265
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3266
+ def get_project_location_data_store_site_search_engine(name, fields: nil, quota_user: nil, options: nil, &block)
3267
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
3268
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine::Representation
3269
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
3270
+ command.params['name'] = name unless name.nil?
3271
+ command.query['fields'] = fields unless fields.nil?
3272
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3273
+ execute_or_queue_command(command, &block)
3274
+ end
3275
+
2537
3276
  # Lists all the DataStores associated with the project.
2538
3277
  # @param [String] parent
2539
3278
  # Required. The parent branch resource name, such as `projects/`project`/
@@ -3161,7 +3900,8 @@ module Google
3161
3900
  # Conversation to update does not exist, a NOT_FOUND error is returned.
3162
3901
  # @param [String] name
3163
3902
  # Immutable. Fully qualified name `project/*/locations/global/collections/`
3164
- # collection`/dataStore/*/conversations/*`
3903
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
3904
+ # collections/`collection`/engines/*/conversations/*`.
3165
3905
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
3166
3906
  # @param [String] update_mask
3167
3907
  # Indicates which fields in the provided Conversation to update. The following
@@ -3604,6 +4344,74 @@ module Google
3604
4344
  execute_or_queue_command(command, &block)
3605
4345
  end
3606
4346
 
4347
+ # Downgrade from advanced site search to basic site search.
4348
+ # @param [String] site_search_engine
4349
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
4350
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
4351
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
4352
+ # @param [String] fields
4353
+ # Selector specifying which fields to include in a partial response.
4354
+ # @param [String] quota_user
4355
+ # Available to use for quota purposes for server-side applications. Can be any
4356
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4357
+ # @param [Google::Apis::RequestOptions] options
4358
+ # Request-specific options
4359
+ #
4360
+ # @yield [result, err] Result & error if block supplied
4361
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4362
+ # @yieldparam err [StandardError] error object if request failed
4363
+ #
4364
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4365
+ #
4366
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4367
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4368
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4369
+ 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)
4370
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch', options)
4371
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest::Representation
4372
+ command.request_object = google_cloud_discoveryengine_v1alpha_disable_advanced_site_search_request_object
4373
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4374
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4375
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
4376
+ command.query['fields'] = fields unless fields.nil?
4377
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4378
+ execute_or_queue_command(command, &block)
4379
+ end
4380
+
4381
+ # Upgrade from basic site search to advanced site search.
4382
+ # @param [String] site_search_engine
4383
+ # Required. Full resource name of the SiteSearchEngine, such as `projects/`
4384
+ # project`/locations/`location`/dataStores/`data_store_id`/siteSearchEngine`.
4385
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest] google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
4386
+ # @param [String] fields
4387
+ # Selector specifying which fields to include in a partial response.
4388
+ # @param [String] quota_user
4389
+ # Available to use for quota purposes for server-side applications. Can be any
4390
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4391
+ # @param [Google::Apis::RequestOptions] options
4392
+ # Request-specific options
4393
+ #
4394
+ # @yield [result, err] Result & error if block supplied
4395
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4396
+ # @yieldparam err [StandardError] error object if request failed
4397
+ #
4398
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4399
+ #
4400
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4401
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4402
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4403
+ 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)
4404
+ command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch', options)
4405
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest::Representation
4406
+ command.request_object = google_cloud_discoveryengine_v1alpha_enable_advanced_site_search_request_object
4407
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4408
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4409
+ command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
4410
+ command.query['fields'] = fields unless fields.nil?
4411
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4412
+ execute_or_queue_command(command, &block)
4413
+ end
4414
+
3607
4415
  # Request on-demand recrawl for a list of URIs.
3608
4416
  # @param [String] site_search_engine
3609
4417
  # Required. Full resource name of the SiteSearchEngine, such as `projects/*/
@@ -3638,6 +4446,228 @@ module Google
3638
4446
  execute_or_queue_command(command, &block)
3639
4447
  end
3640
4448
 
4449
+ # Creates TargetSite in a batch.
4450
+ # @param [String] parent
4451
+ # Required. The parent resource shared by all TargetSites being created. `
4452
+ # projects/`project`/locations/`location`/collections/`collection`/dataStores/`
4453
+ # data_store`/siteSearchEngine`. The parent field in the CreateBookRequest
4454
+ # messages must either be empty or match this field.
4455
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest] google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object
4456
+ # @param [String] fields
4457
+ # Selector specifying which fields to include in a partial response.
4458
+ # @param [String] quota_user
4459
+ # Available to use for quota purposes for server-side applications. Can be any
4460
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4461
+ # @param [Google::Apis::RequestOptions] options
4462
+ # Request-specific options
4463
+ #
4464
+ # @yield [result, err] Result & error if block supplied
4465
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4466
+ # @yieldparam err [StandardError] error object if request failed
4467
+ #
4468
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4469
+ #
4470
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4471
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4472
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4473
+ 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)
4474
+ command = make_simple_command(:post, 'v1alpha/{+parent}/targetSites:batchCreate', options)
4475
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest::Representation
4476
+ command.request_object = google_cloud_discoveryengine_v1alpha_batch_create_target_sites_request_object
4477
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4478
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4479
+ command.params['parent'] = parent unless parent.nil?
4480
+ command.query['fields'] = fields unless fields.nil?
4481
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4482
+ execute_or_queue_command(command, &block)
4483
+ end
4484
+
4485
+ # Creates a TargetSite.
4486
+ # @param [String] parent
4487
+ # Required. Parent resource name of TargetSite, such as `projects/`project`/
4488
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
4489
+ # siteSearchEngine`.
4490
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] google_cloud_discoveryengine_v1alpha_target_site_object
4491
+ # @param [String] fields
4492
+ # Selector specifying which fields to include in a partial response.
4493
+ # @param [String] quota_user
4494
+ # Available to use for quota purposes for server-side applications. Can be any
4495
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4496
+ # @param [Google::Apis::RequestOptions] options
4497
+ # Request-specific options
4498
+ #
4499
+ # @yield [result, err] Result & error if block supplied
4500
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4501
+ # @yieldparam err [StandardError] error object if request failed
4502
+ #
4503
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4504
+ #
4505
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4506
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4507
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4508
+ 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)
4509
+ command = make_simple_command(:post, 'v1alpha/{+parent}/targetSites', options)
4510
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
4511
+ command.request_object = google_cloud_discoveryengine_v1alpha_target_site_object
4512
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4513
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4514
+ command.params['parent'] = parent unless parent.nil?
4515
+ command.query['fields'] = fields unless fields.nil?
4516
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4517
+ execute_or_queue_command(command, &block)
4518
+ end
4519
+
4520
+ # Deletes a TargetSite.
4521
+ # @param [String] name
4522
+ # Required. Full resource name of TargetSite, such as `projects/`project`/
4523
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
4524
+ # siteSearchEngine/targetSites/`target_site``. If the caller does not have
4525
+ # permission to access the TargetSite, regardless of whether or not it exists, a
4526
+ # PERMISSION_DENIED error is returned. If the requested TargetSite does not
4527
+ # exist, a NOT_FOUND error is returned.
4528
+ # @param [String] fields
4529
+ # Selector specifying which fields to include in a partial response.
4530
+ # @param [String] quota_user
4531
+ # Available to use for quota purposes for server-side applications. Can be any
4532
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4533
+ # @param [Google::Apis::RequestOptions] options
4534
+ # Request-specific options
4535
+ #
4536
+ # @yield [result, err] Result & error if block supplied
4537
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4538
+ # @yieldparam err [StandardError] error object if request failed
4539
+ #
4540
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4541
+ #
4542
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4543
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4544
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4545
+ def delete_project_location_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
4546
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
4547
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4548
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4549
+ command.params['name'] = name unless name.nil?
4550
+ command.query['fields'] = fields unless fields.nil?
4551
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4552
+ execute_or_queue_command(command, &block)
4553
+ end
4554
+
4555
+ # Gets a TargetSite.
4556
+ # @param [String] name
4557
+ # Required. Full resource name of TargetSite, such as `projects/`project`/
4558
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
4559
+ # siteSearchEngine/targetSites/`target_site``. If the caller does not have
4560
+ # permission to access the TargetSite, regardless of whether or not it exists, a
4561
+ # PERMISSION_DENIED error is returned. If the requested TargetSite does not
4562
+ # exist, a NOT_FOUND error is returned.
4563
+ # @param [String] fields
4564
+ # Selector specifying which fields to include in a partial response.
4565
+ # @param [String] quota_user
4566
+ # Available to use for quota purposes for server-side applications. Can be any
4567
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4568
+ # @param [Google::Apis::RequestOptions] options
4569
+ # Request-specific options
4570
+ #
4571
+ # @yield [result, err] Result & error if block supplied
4572
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] parsed result object
4573
+ # @yieldparam err [StandardError] error object if request failed
4574
+ #
4575
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite]
4576
+ #
4577
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4578
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4579
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4580
+ def get_project_location_data_store_site_search_engine_target_site(name, fields: nil, quota_user: nil, options: nil, &block)
4581
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4582
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
4583
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite
4584
+ command.params['name'] = name unless name.nil?
4585
+ command.query['fields'] = fields unless fields.nil?
4586
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4587
+ execute_or_queue_command(command, &block)
4588
+ end
4589
+
4590
+ # Gets a list of TargetSites.
4591
+ # @param [String] parent
4592
+ # Required. The parent site search engine resource name, such as `projects/`
4593
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
4594
+ # siteSearchEngine`. If the caller does not have permission to list TargetSites
4595
+ # under this site search engine, regardless of whether or not this branch exists,
4596
+ # a PERMISSION_DENIED error is returned.
4597
+ # @param [Fixnum] page_size
4598
+ # Requested page size. Server may return fewer items than requested. If
4599
+ # unspecified, server will pick an appropriate default. The maximum value is
4600
+ # 1000; values above 1000 will be coerced to 1000. If this field is negative, an
4601
+ # INVALID_ARGUMENT error is returned.
4602
+ # @param [String] page_token
4603
+ # A page token, received from a previous `ListTargetSites` call. Provide this to
4604
+ # retrieve the subsequent page. When paginating, all other parameters provided
4605
+ # to `ListTargetSites` must match the call that provided the page token.
4606
+ # @param [String] fields
4607
+ # Selector specifying which fields to include in a partial response.
4608
+ # @param [String] quota_user
4609
+ # Available to use for quota purposes for server-side applications. Can be any
4610
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4611
+ # @param [Google::Apis::RequestOptions] options
4612
+ # Request-specific options
4613
+ #
4614
+ # @yield [result, err] Result & error if block supplied
4615
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse] parsed result object
4616
+ # @yieldparam err [StandardError] error object if request failed
4617
+ #
4618
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse]
4619
+ #
4620
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4621
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4622
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4623
+ 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)
4624
+ command = make_simple_command(:get, 'v1alpha/{+parent}/targetSites', options)
4625
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse::Representation
4626
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse
4627
+ command.params['parent'] = parent unless parent.nil?
4628
+ command.query['pageSize'] = page_size unless page_size.nil?
4629
+ command.query['pageToken'] = page_token unless page_token.nil?
4630
+ command.query['fields'] = fields unless fields.nil?
4631
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4632
+ execute_or_queue_command(command, &block)
4633
+ end
4634
+
4635
+ # Updates a TargetSite.
4636
+ # @param [String] name
4637
+ # Output only. The fully qualified resource name of the target site. `projects/`
4638
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
4639
+ # siteSearchEngine/targetSites/`target_site`` The `target_site_id` is system-
4640
+ # generated.
4641
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite] google_cloud_discoveryengine_v1alpha_target_site_object
4642
+ # @param [String] fields
4643
+ # Selector specifying which fields to include in a partial response.
4644
+ # @param [String] quota_user
4645
+ # Available to use for quota purposes for server-side applications. Can be any
4646
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4647
+ # @param [Google::Apis::RequestOptions] options
4648
+ # Request-specific options
4649
+ #
4650
+ # @yield [result, err] Result & error if block supplied
4651
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
4652
+ # @yieldparam err [StandardError] error object if request failed
4653
+ #
4654
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
4655
+ #
4656
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4657
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4658
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4659
+ 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)
4660
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
4661
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
4662
+ command.request_object = google_cloud_discoveryengine_v1alpha_target_site_object
4663
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
4664
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
4665
+ command.params['name'] = name unless name.nil?
4666
+ command.query['fields'] = fields unless fields.nil?
4667
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4668
+ execute_or_queue_command(command, &block)
4669
+ end
4670
+
3641
4671
  # Writes a single user event from the browser. This uses a GET request to due to
3642
4672
  # browser restriction of POST-ing to a third-party domain. This method is used
3643
4673
  # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.