google-apis-discoveryengine_v1 0.27.0 → 0.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/discoveryengine_v1/classes.rb +1733 -121
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1/representations.rb +743 -34
- data/lib/google/apis/discoveryengine_v1/service.rb +472 -0
- metadata +4 -4
@@ -2617,6 +2617,109 @@ module Google
|
|
2617
2617
|
execute_or_queue_command(command, &block)
|
2618
2618
|
end
|
2619
2619
|
|
2620
|
+
# Creates a Sitemap.
|
2621
|
+
# @param [String] parent
|
2622
|
+
# Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
|
2623
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
2624
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Sitemap] google_cloud_discoveryengine_v1_sitemap_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::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
2635
|
+
# @yieldparam err [StandardError] error object if request failed
|
2636
|
+
#
|
2637
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
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 create_project_location_collection_data_store_site_search_engine_sitemap(parent, google_cloud_discoveryengine_v1_sitemap_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2643
|
+
command = make_simple_command(:post, 'v1/{+parent}/sitemaps', options)
|
2644
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Sitemap::Representation
|
2645
|
+
command.request_object = google_cloud_discoveryengine_v1_sitemap_object
|
2646
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
2647
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
2648
|
+
command.params['parent'] = parent unless parent.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
|
+
# Deletes a Sitemap.
|
2655
|
+
# @param [String] name
|
2656
|
+
# Required. Full resource name of Sitemap, such as `projects/`project`/locations/
|
2657
|
+
# `location`/collections/`collection`/dataStores/`data_store`/siteSearchEngine/
|
2658
|
+
# sitemaps/`sitemap``. If the caller does not have permission to access the
|
2659
|
+
# Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is
|
2660
|
+
# returned. If the requested Sitemap does not exist, a NOT_FOUND error is
|
2661
|
+
# returned.
|
2662
|
+
# @param [String] fields
|
2663
|
+
# Selector specifying which fields to include in a partial response.
|
2664
|
+
# @param [String] quota_user
|
2665
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2666
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2667
|
+
# @param [Google::Apis::RequestOptions] options
|
2668
|
+
# Request-specific options
|
2669
|
+
#
|
2670
|
+
# @yield [result, err] Result & error if block supplied
|
2671
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
2672
|
+
# @yieldparam err [StandardError] error object if request failed
|
2673
|
+
#
|
2674
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
2675
|
+
#
|
2676
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2677
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2678
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2679
|
+
def delete_project_location_collection_data_store_site_search_engine_sitemap(name, fields: nil, quota_user: nil, options: nil, &block)
|
2680
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
2681
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
2682
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
2683
|
+
command.params['name'] = name unless name.nil?
|
2684
|
+
command.query['fields'] = fields unless fields.nil?
|
2685
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2686
|
+
execute_or_queue_command(command, &block)
|
2687
|
+
end
|
2688
|
+
|
2689
|
+
# Fetch Sitemaps in a DataStore.
|
2690
|
+
# @param [String] parent
|
2691
|
+
# Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
|
2692
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
2693
|
+
# @param [Array<String>, String] matcher_uris_matcher_uris
|
2694
|
+
# The Sitemap uris.
|
2695
|
+
# @param [String] fields
|
2696
|
+
# Selector specifying which fields to include in a partial response.
|
2697
|
+
# @param [String] quota_user
|
2698
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2699
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2700
|
+
# @param [Google::Apis::RequestOptions] options
|
2701
|
+
# Request-specific options
|
2702
|
+
#
|
2703
|
+
# @yield [result, err] Result & error if block supplied
|
2704
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchSitemapsResponse] parsed result object
|
2705
|
+
# @yieldparam err [StandardError] error object if request failed
|
2706
|
+
#
|
2707
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchSitemapsResponse]
|
2708
|
+
#
|
2709
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2710
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2711
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2712
|
+
def fetch_project_location_collection_data_store_site_search_engine_sitemap(parent, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2713
|
+
command = make_simple_command(:get, 'v1/{+parent}/sitemaps:fetch', options)
|
2714
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchSitemapsResponse::Representation
|
2715
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchSitemapsResponse
|
2716
|
+
command.params['parent'] = parent unless parent.nil?
|
2717
|
+
command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.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
|
+
|
2620
2723
|
# Creates TargetSite in a batch.
|
2621
2724
|
# @param [String] parent
|
2622
2725
|
# Required. The parent resource shared by all TargetSites being created. `
|
@@ -6500,6 +6603,109 @@ module Google
|
|
6500
6603
|
execute_or_queue_command(command, &block)
|
6501
6604
|
end
|
6502
6605
|
|
6606
|
+
# Creates a Sitemap.
|
6607
|
+
# @param [String] parent
|
6608
|
+
# Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
|
6609
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
6610
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Sitemap] google_cloud_discoveryengine_v1_sitemap_object
|
6611
|
+
# @param [String] fields
|
6612
|
+
# Selector specifying which fields to include in a partial response.
|
6613
|
+
# @param [String] quota_user
|
6614
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6615
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6616
|
+
# @param [Google::Apis::RequestOptions] options
|
6617
|
+
# Request-specific options
|
6618
|
+
#
|
6619
|
+
# @yield [result, err] Result & error if block supplied
|
6620
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
6621
|
+
# @yieldparam err [StandardError] error object if request failed
|
6622
|
+
#
|
6623
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
6624
|
+
#
|
6625
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6626
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6627
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6628
|
+
def create_project_location_data_store_site_search_engine_sitemap(parent, google_cloud_discoveryengine_v1_sitemap_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
6629
|
+
command = make_simple_command(:post, 'v1/{+parent}/sitemaps', options)
|
6630
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Sitemap::Representation
|
6631
|
+
command.request_object = google_cloud_discoveryengine_v1_sitemap_object
|
6632
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
6633
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
6634
|
+
command.params['parent'] = parent unless parent.nil?
|
6635
|
+
command.query['fields'] = fields unless fields.nil?
|
6636
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6637
|
+
execute_or_queue_command(command, &block)
|
6638
|
+
end
|
6639
|
+
|
6640
|
+
# Deletes a Sitemap.
|
6641
|
+
# @param [String] name
|
6642
|
+
# Required. Full resource name of Sitemap, such as `projects/`project`/locations/
|
6643
|
+
# `location`/collections/`collection`/dataStores/`data_store`/siteSearchEngine/
|
6644
|
+
# sitemaps/`sitemap``. If the caller does not have permission to access the
|
6645
|
+
# Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is
|
6646
|
+
# returned. If the requested Sitemap does not exist, a NOT_FOUND error is
|
6647
|
+
# returned.
|
6648
|
+
# @param [String] fields
|
6649
|
+
# Selector specifying which fields to include in a partial response.
|
6650
|
+
# @param [String] quota_user
|
6651
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6652
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6653
|
+
# @param [Google::Apis::RequestOptions] options
|
6654
|
+
# Request-specific options
|
6655
|
+
#
|
6656
|
+
# @yield [result, err] Result & error if block supplied
|
6657
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
6658
|
+
# @yieldparam err [StandardError] error object if request failed
|
6659
|
+
#
|
6660
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
6661
|
+
#
|
6662
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6663
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6664
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6665
|
+
def delete_project_location_data_store_site_search_engine_sitemap(name, fields: nil, quota_user: nil, options: nil, &block)
|
6666
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
6667
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
6668
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
6669
|
+
command.params['name'] = name unless name.nil?
|
6670
|
+
command.query['fields'] = fields unless fields.nil?
|
6671
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6672
|
+
execute_or_queue_command(command, &block)
|
6673
|
+
end
|
6674
|
+
|
6675
|
+
# Fetch Sitemaps in a DataStore.
|
6676
|
+
# @param [String] parent
|
6677
|
+
# Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
|
6678
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
6679
|
+
# @param [Array<String>, String] matcher_uris_matcher_uris
|
6680
|
+
# The Sitemap uris.
|
6681
|
+
# @param [String] fields
|
6682
|
+
# Selector specifying which fields to include in a partial response.
|
6683
|
+
# @param [String] quota_user
|
6684
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6685
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6686
|
+
# @param [Google::Apis::RequestOptions] options
|
6687
|
+
# Request-specific options
|
6688
|
+
#
|
6689
|
+
# @yield [result, err] Result & error if block supplied
|
6690
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchSitemapsResponse] parsed result object
|
6691
|
+
# @yieldparam err [StandardError] error object if request failed
|
6692
|
+
#
|
6693
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchSitemapsResponse]
|
6694
|
+
#
|
6695
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6696
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6697
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6698
|
+
def fetch_project_location_data_store_site_search_engine_sitemap(parent, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
|
6699
|
+
command = make_simple_command(:get, 'v1/{+parent}/sitemaps:fetch', options)
|
6700
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchSitemapsResponse::Representation
|
6701
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchSitemapsResponse
|
6702
|
+
command.params['parent'] = parent unless parent.nil?
|
6703
|
+
command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
|
6704
|
+
command.query['fields'] = fields unless fields.nil?
|
6705
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6706
|
+
execute_or_queue_command(command, &block)
|
6707
|
+
end
|
6708
|
+
|
6503
6709
|
# Creates TargetSite in a batch.
|
6504
6710
|
# @param [String] parent
|
6505
6711
|
# Required. The parent resource shared by all TargetSites being created. `
|
@@ -6994,6 +7200,272 @@ module Google
|
|
6994
7200
|
execute_or_queue_command(command, &block)
|
6995
7201
|
end
|
6996
7202
|
|
7203
|
+
# Creates a new Identity Mapping Store.
|
7204
|
+
# @param [String] parent
|
7205
|
+
# Required. The parent collection resource name, such as `projects/`project`/
|
7206
|
+
# locations/`location``.
|
7207
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore] google_cloud_discoveryengine_v1_identity_mapping_store_object
|
7208
|
+
# @param [String] cmek_config_name
|
7209
|
+
# Resource name of the CmekConfig to use for protecting this Identity Mapping
|
7210
|
+
# Store.
|
7211
|
+
# @param [Boolean] disable_cmek
|
7212
|
+
# Identity Mapping Store without CMEK protections. If a default CmekConfig is
|
7213
|
+
# set for the project, setting this field will override the default CmekConfig
|
7214
|
+
# as well.
|
7215
|
+
# @param [String] identity_mapping_store_id
|
7216
|
+
# Required. The ID of the Identity Mapping Store to create. The ID must contain
|
7217
|
+
# only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The
|
7218
|
+
# maximum length is 63 characters.
|
7219
|
+
# @param [String] fields
|
7220
|
+
# Selector specifying which fields to include in a partial response.
|
7221
|
+
# @param [String] quota_user
|
7222
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7223
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7224
|
+
# @param [Google::Apis::RequestOptions] options
|
7225
|
+
# Request-specific options
|
7226
|
+
#
|
7227
|
+
# @yield [result, err] Result & error if block supplied
|
7228
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore] parsed result object
|
7229
|
+
# @yieldparam err [StandardError] error object if request failed
|
7230
|
+
#
|
7231
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore]
|
7232
|
+
#
|
7233
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7234
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7235
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7236
|
+
def create_project_location_identity_mapping_store(parent, google_cloud_discoveryengine_v1_identity_mapping_store_object = nil, cmek_config_name: nil, disable_cmek: nil, identity_mapping_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
7237
|
+
command = make_simple_command(:post, 'v1/{+parent}/identityMappingStores', options)
|
7238
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore::Representation
|
7239
|
+
command.request_object = google_cloud_discoveryengine_v1_identity_mapping_store_object
|
7240
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore::Representation
|
7241
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore
|
7242
|
+
command.params['parent'] = parent unless parent.nil?
|
7243
|
+
command.query['cmekConfigName'] = cmek_config_name unless cmek_config_name.nil?
|
7244
|
+
command.query['disableCmek'] = disable_cmek unless disable_cmek.nil?
|
7245
|
+
command.query['identityMappingStoreId'] = identity_mapping_store_id unless identity_mapping_store_id.nil?
|
7246
|
+
command.query['fields'] = fields unless fields.nil?
|
7247
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7248
|
+
execute_or_queue_command(command, &block)
|
7249
|
+
end
|
7250
|
+
|
7251
|
+
# Deletes the Identity Mapping Store.
|
7252
|
+
# @param [String] name
|
7253
|
+
# Required. The name of the Identity Mapping Store to delete. Format: `projects/`
|
7254
|
+
# project`/locations/`location`/identityMappingStores/`identityMappingStore``
|
7255
|
+
# @param [String] fields
|
7256
|
+
# Selector specifying which fields to include in a partial response.
|
7257
|
+
# @param [String] quota_user
|
7258
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7259
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7260
|
+
# @param [Google::Apis::RequestOptions] options
|
7261
|
+
# Request-specific options
|
7262
|
+
#
|
7263
|
+
# @yield [result, err] Result & error if block supplied
|
7264
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
7265
|
+
# @yieldparam err [StandardError] error object if request failed
|
7266
|
+
#
|
7267
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
7268
|
+
#
|
7269
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7270
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7271
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7272
|
+
def delete_project_location_identity_mapping_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
7273
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
7274
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
7275
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
7276
|
+
command.params['name'] = name unless name.nil?
|
7277
|
+
command.query['fields'] = fields unless fields.nil?
|
7278
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7279
|
+
execute_or_queue_command(command, &block)
|
7280
|
+
end
|
7281
|
+
|
7282
|
+
# Gets the Identity Mapping Store.
|
7283
|
+
# @param [String] name
|
7284
|
+
# Required. The name of the Identity Mapping Store to get. Format: `projects/`
|
7285
|
+
# project`/locations/`location`/identityMappingStores/`identityMappingStore``
|
7286
|
+
# @param [String] fields
|
7287
|
+
# Selector specifying which fields to include in a partial response.
|
7288
|
+
# @param [String] quota_user
|
7289
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7290
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7291
|
+
# @param [Google::Apis::RequestOptions] options
|
7292
|
+
# Request-specific options
|
7293
|
+
#
|
7294
|
+
# @yield [result, err] Result & error if block supplied
|
7295
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore] parsed result object
|
7296
|
+
# @yieldparam err [StandardError] error object if request failed
|
7297
|
+
#
|
7298
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore]
|
7299
|
+
#
|
7300
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7301
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7302
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7303
|
+
def get_project_location_identity_mapping_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
7304
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
7305
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore::Representation
|
7306
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore
|
7307
|
+
command.params['name'] = name unless name.nil?
|
7308
|
+
command.query['fields'] = fields unless fields.nil?
|
7309
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7310
|
+
execute_or_queue_command(command, &block)
|
7311
|
+
end
|
7312
|
+
|
7313
|
+
# Imports a list of Identity Mapping Entries to an Identity Mapping Store.
|
7314
|
+
# @param [String] identity_mapping_store
|
7315
|
+
# Required. The name of the Identity Mapping Store to import Identity Mapping
|
7316
|
+
# Entries to. Format: `projects/`project`/locations/`location`/
|
7317
|
+
# identityMappingStores/`identityMappingStore``
|
7318
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest] google_cloud_discoveryengine_v1_import_identity_mappings_request_object
|
7319
|
+
# @param [String] fields
|
7320
|
+
# Selector specifying which fields to include in a partial response.
|
7321
|
+
# @param [String] quota_user
|
7322
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7323
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7324
|
+
# @param [Google::Apis::RequestOptions] options
|
7325
|
+
# Request-specific options
|
7326
|
+
#
|
7327
|
+
# @yield [result, err] Result & error if block supplied
|
7328
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
7329
|
+
# @yieldparam err [StandardError] error object if request failed
|
7330
|
+
#
|
7331
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
7332
|
+
#
|
7333
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7334
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7335
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7336
|
+
def import_project_location_identity_mapping_store_identity_mappings(identity_mapping_store, google_cloud_discoveryengine_v1_import_identity_mappings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
7337
|
+
command = make_simple_command(:post, 'v1/{+identityMappingStore}:importIdentityMappings', options)
|
7338
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest::Representation
|
7339
|
+
command.request_object = google_cloud_discoveryengine_v1_import_identity_mappings_request_object
|
7340
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
7341
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
7342
|
+
command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
|
7343
|
+
command.query['fields'] = fields unless fields.nil?
|
7344
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7345
|
+
execute_or_queue_command(command, &block)
|
7346
|
+
end
|
7347
|
+
|
7348
|
+
# Lists all Identity Mapping Stores.
|
7349
|
+
# @param [String] parent
|
7350
|
+
# Required. The parent of the Identity Mapping Stores to list. Format: `projects/
|
7351
|
+
# `project`/locations/`location``.
|
7352
|
+
# @param [Fixnum] page_size
|
7353
|
+
# Maximum number of IdentityMappingStores to return. If unspecified, defaults to
|
7354
|
+
# 100. The maximum allowed value is 1000. Values above 1000 will be coerced to
|
7355
|
+
# 1000.
|
7356
|
+
# @param [String] page_token
|
7357
|
+
# A page token, received from a previous `ListIdentityMappingStores` call.
|
7358
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
7359
|
+
# parameters provided to `ListIdentityMappingStores` must match the call that
|
7360
|
+
# provided the page token.
|
7361
|
+
# @param [String] fields
|
7362
|
+
# Selector specifying which fields to include in a partial response.
|
7363
|
+
# @param [String] quota_user
|
7364
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7365
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7366
|
+
# @param [Google::Apis::RequestOptions] options
|
7367
|
+
# Request-specific options
|
7368
|
+
#
|
7369
|
+
# @yield [result, err] Result & error if block supplied
|
7370
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse] parsed result object
|
7371
|
+
# @yieldparam err [StandardError] error object if request failed
|
7372
|
+
#
|
7373
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse]
|
7374
|
+
#
|
7375
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7376
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7377
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7378
|
+
def list_project_location_identity_mapping_stores(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
7379
|
+
command = make_simple_command(:get, 'v1/{+parent}/identityMappingStores', options)
|
7380
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse::Representation
|
7381
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse
|
7382
|
+
command.params['parent'] = parent unless parent.nil?
|
7383
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
7384
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
7385
|
+
command.query['fields'] = fields unless fields.nil?
|
7386
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7387
|
+
execute_or_queue_command(command, &block)
|
7388
|
+
end
|
7389
|
+
|
7390
|
+
# Lists Identity Mappings in an Identity Mapping Store.
|
7391
|
+
# @param [String] identity_mapping_store
|
7392
|
+
# Required. The name of the Identity Mapping Store to list Identity Mapping
|
7393
|
+
# Entries in. Format: `projects/`project`/locations/`location`/
|
7394
|
+
# identityMappingStores/`identityMappingStore``
|
7395
|
+
# @param [Fixnum] page_size
|
7396
|
+
# Maximum number of IdentityMappings to return. If unspecified, defaults to 2000.
|
7397
|
+
# The maximum allowed value is 10000. Values above 10000 will be coerced to
|
7398
|
+
# 10000.
|
7399
|
+
# @param [String] page_token
|
7400
|
+
# A page token, received from a previous `ListIdentityMappings` call. Provide
|
7401
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
7402
|
+
# provided to `ListIdentityMappings` must match the call that provided the page
|
7403
|
+
# token.
|
7404
|
+
# @param [String] fields
|
7405
|
+
# Selector specifying which fields to include in a partial response.
|
7406
|
+
# @param [String] quota_user
|
7407
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7408
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7409
|
+
# @param [Google::Apis::RequestOptions] options
|
7410
|
+
# Request-specific options
|
7411
|
+
#
|
7412
|
+
# @yield [result, err] Result & error if block supplied
|
7413
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse] parsed result object
|
7414
|
+
# @yieldparam err [StandardError] error object if request failed
|
7415
|
+
#
|
7416
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse]
|
7417
|
+
#
|
7418
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7419
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7420
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7421
|
+
def list_project_location_identity_mapping_store_identity_mappings(identity_mapping_store, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
7422
|
+
command = make_simple_command(:get, 'v1/{+identityMappingStore}:listIdentityMappings', options)
|
7423
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse::Representation
|
7424
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse
|
7425
|
+
command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
|
7426
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
7427
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
7428
|
+
command.query['fields'] = fields unless fields.nil?
|
7429
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7430
|
+
execute_or_queue_command(command, &block)
|
7431
|
+
end
|
7432
|
+
|
7433
|
+
# Purges specified or all Identity Mapping Entries from an Identity Mapping
|
7434
|
+
# Store.
|
7435
|
+
# @param [String] identity_mapping_store
|
7436
|
+
# Required. The name of the Identity Mapping Store to purge Identity Mapping
|
7437
|
+
# Entries from. Format: `projects/`project`/locations/`location`/
|
7438
|
+
# identityMappingStores/`identityMappingStore``
|
7439
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest] google_cloud_discoveryengine_v1_purge_identity_mappings_request_object
|
7440
|
+
# @param [String] fields
|
7441
|
+
# Selector specifying which fields to include in a partial response.
|
7442
|
+
# @param [String] quota_user
|
7443
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7444
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7445
|
+
# @param [Google::Apis::RequestOptions] options
|
7446
|
+
# Request-specific options
|
7447
|
+
#
|
7448
|
+
# @yield [result, err] Result & error if block supplied
|
7449
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
7450
|
+
# @yieldparam err [StandardError] error object if request failed
|
7451
|
+
#
|
7452
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
7453
|
+
#
|
7454
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7455
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7456
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7457
|
+
def purge_project_location_identity_mapping_store_identity_mappings(identity_mapping_store, google_cloud_discoveryengine_v1_purge_identity_mappings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
7458
|
+
command = make_simple_command(:post, 'v1/{+identityMappingStore}:purgeIdentityMappings', options)
|
7459
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest::Representation
|
7460
|
+
command.request_object = google_cloud_discoveryengine_v1_purge_identity_mappings_request_object
|
7461
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
7462
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
7463
|
+
command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
|
7464
|
+
command.query['fields'] = fields unless fields.nil?
|
7465
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7466
|
+
execute_or_queue_command(command, &block)
|
7467
|
+
end
|
7468
|
+
|
6997
7469
|
# Gets the latest state of a long-running operation. Clients can use this method
|
6998
7470
|
# to poll the operation result at intervals as recommended by the API service.
|
6999
7471
|
# @param [String] name
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-discoveryengine_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.28.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
bindir: bin
|
9
9
|
cert_chain: []
|
10
|
-
date: 2025-
|
10
|
+
date: 2025-03-02 00:00:00.000000000 Z
|
11
11
|
dependencies:
|
12
12
|
- !ruby/object:Gem::Dependency
|
13
13
|
name: google-apis-core
|
@@ -57,7 +57,7 @@ licenses:
|
|
57
57
|
metadata:
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1/CHANGELOG.md
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.28.0
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
|
62
62
|
rdoc_options: []
|
63
63
|
require_paths:
|
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
73
73
|
- !ruby/object:Gem::Version
|
74
74
|
version: '0'
|
75
75
|
requirements: []
|
76
|
-
rubygems_version: 3.6.
|
76
|
+
rubygems_version: 3.6.5
|
77
77
|
specification_version: 4
|
78
78
|
summary: Simple REST client for Discovery Engine API V1
|
79
79
|
test_files: []
|