google-apis-discoveryengine_v1beta 0.55.0 → 0.56.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_v1beta/classes.rb +1962 -137
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +811 -21
- data/lib/google/apis/discoveryengine_v1beta/service.rb +453 -0
- metadata +4 -4
@@ -121,6 +121,120 @@ module Google
|
|
121
121
|
execute_or_queue_command(command, &block)
|
122
122
|
end
|
123
123
|
|
124
|
+
# Obtains the time series data of organic or dedicated crawl rate for monitoring.
|
125
|
+
# When dedicated crawl rate is not set, it will return vertex AI's organic
|
126
|
+
# crawl rate time series. Organic crawl means Google automatically crawl the
|
127
|
+
# internet at its own convenience. When dedicated crawl rate is set, it will
|
128
|
+
# return vertex AI's dedicated crawl rate time series.
|
129
|
+
# @param [String] location
|
130
|
+
# Required. The location resource where crawl rate management will be performed.
|
131
|
+
# Format: `projects/`project`/locations/`location``
|
132
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest] google_cloud_discoveryengine_v1beta_obtain_crawl_rate_request_object
|
133
|
+
# @param [String] fields
|
134
|
+
# Selector specifying which fields to include in a partial response.
|
135
|
+
# @param [String] quota_user
|
136
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
137
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
138
|
+
# @param [Google::Apis::RequestOptions] options
|
139
|
+
# Request-specific options
|
140
|
+
#
|
141
|
+
# @yield [result, err] Result & error if block supplied
|
142
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse] parsed result object
|
143
|
+
# @yieldparam err [StandardError] error object if request failed
|
144
|
+
#
|
145
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse]
|
146
|
+
#
|
147
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
148
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
149
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
150
|
+
def obtain_project_location_crawl_rate(location, google_cloud_discoveryengine_v1beta_obtain_crawl_rate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
151
|
+
command = make_simple_command(:post, 'v1beta/{+location}:obtainCrawlRate', options)
|
152
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest::Representation
|
153
|
+
command.request_object = google_cloud_discoveryengine_v1beta_obtain_crawl_rate_request_object
|
154
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse::Representation
|
155
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse
|
156
|
+
command.params['location'] = location unless location.nil?
|
157
|
+
command.query['fields'] = fields unless fields.nil?
|
158
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
159
|
+
execute_or_queue_command(command, &block)
|
160
|
+
end
|
161
|
+
|
162
|
+
# Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl
|
163
|
+
# rate was set, this will disable vertex AI's crawl bot from using the dedicated
|
164
|
+
# crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-
|
165
|
+
# op.
|
166
|
+
# @param [String] location
|
167
|
+
# Required. The location resource where crawl rate management will be performed.
|
168
|
+
# Format: `projects/`project`/locations/`location``
|
169
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest] google_cloud_discoveryengine_v1beta_remove_dedicated_crawl_rate_request_object
|
170
|
+
# @param [String] fields
|
171
|
+
# Selector specifying which fields to include in a partial response.
|
172
|
+
# @param [String] quota_user
|
173
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
174
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
175
|
+
# @param [Google::Apis::RequestOptions] options
|
176
|
+
# Request-specific options
|
177
|
+
#
|
178
|
+
# @yield [result, err] Result & error if block supplied
|
179
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
180
|
+
# @yieldparam err [StandardError] error object if request failed
|
181
|
+
#
|
182
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
183
|
+
#
|
184
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
185
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
186
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
187
|
+
def remove_project_location_dedicated_crawl_rate(location, google_cloud_discoveryengine_v1beta_remove_dedicated_crawl_rate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
188
|
+
command = make_simple_command(:post, 'v1beta/{+location}:removeDedicatedCrawlRate', options)
|
189
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest::Representation
|
190
|
+
command.request_object = google_cloud_discoveryengine_v1beta_remove_dedicated_crawl_rate_request_object
|
191
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
192
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
193
|
+
command.params['location'] = location unless location.nil?
|
194
|
+
command.query['fields'] = fields unless fields.nil?
|
195
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
196
|
+
execute_or_queue_command(command, &block)
|
197
|
+
end
|
198
|
+
|
199
|
+
# Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl
|
200
|
+
# rate was not set, this will enable vertex AI's crawl bot to use the new
|
201
|
+
# dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex
|
202
|
+
# AI's crawl bot will try to update the rate to the new value. If the new value
|
203
|
+
# is too high, the crawl bot may crawl at a lower rate to avoid overloading the
|
204
|
+
# user's website.
|
205
|
+
# @param [String] location
|
206
|
+
# Required. The location resource where crawl rate management will be performed.
|
207
|
+
# Format: `projects/`project`/locations/`location``
|
208
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest] google_cloud_discoveryengine_v1beta_set_dedicated_crawl_rate_request_object
|
209
|
+
# @param [String] fields
|
210
|
+
# Selector specifying which fields to include in a partial response.
|
211
|
+
# @param [String] quota_user
|
212
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
213
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
214
|
+
# @param [Google::Apis::RequestOptions] options
|
215
|
+
# Request-specific options
|
216
|
+
#
|
217
|
+
# @yield [result, err] Result & error if block supplied
|
218
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
219
|
+
# @yieldparam err [StandardError] error object if request failed
|
220
|
+
#
|
221
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
222
|
+
#
|
223
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
224
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
225
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
226
|
+
def set_project_location_dedicated_crawl_rate(location, google_cloud_discoveryengine_v1beta_set_dedicated_crawl_rate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
227
|
+
command = make_simple_command(:post, 'v1beta/{+location}:setDedicatedCrawlRate', options)
|
228
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest::Representation
|
229
|
+
command.request_object = google_cloud_discoveryengine_v1beta_set_dedicated_crawl_rate_request_object
|
230
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
231
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
232
|
+
command.params['location'] = location unless location.nil?
|
233
|
+
command.query['fields'] = fields unless fields.nil?
|
234
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
235
|
+
execute_or_queue_command(command, &block)
|
236
|
+
end
|
237
|
+
|
124
238
|
# Gets the latest state of a long-running operation. Clients can use this method
|
125
239
|
# to poll the operation result at intervals as recommended by the API service.
|
126
240
|
# @param [String] name
|
@@ -2794,6 +2908,40 @@ module Google
|
|
2794
2908
|
execute_or_queue_command(command, &block)
|
2795
2909
|
end
|
2796
2910
|
|
2911
|
+
# Fetch Sitemaps in a DataStore.
|
2912
|
+
# @param [String] parent
|
2913
|
+
# Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
|
2914
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
2915
|
+
# @param [Array<String>, String] matcher_uris_matcher_uris
|
2916
|
+
# The Sitemap uris.
|
2917
|
+
# @param [String] fields
|
2918
|
+
# Selector specifying which fields to include in a partial response.
|
2919
|
+
# @param [String] quota_user
|
2920
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2921
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2922
|
+
# @param [Google::Apis::RequestOptions] options
|
2923
|
+
# Request-specific options
|
2924
|
+
#
|
2925
|
+
# @yield [result, err] Result & error if block supplied
|
2926
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse] parsed result object
|
2927
|
+
# @yieldparam err [StandardError] error object if request failed
|
2928
|
+
#
|
2929
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse]
|
2930
|
+
#
|
2931
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2932
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2933
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2934
|
+
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)
|
2935
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/sitemaps:fetch', options)
|
2936
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse::Representation
|
2937
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse
|
2938
|
+
command.params['parent'] = parent unless parent.nil?
|
2939
|
+
command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
|
2940
|
+
command.query['fields'] = fields unless fields.nil?
|
2941
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2942
|
+
execute_or_queue_command(command, &block)
|
2943
|
+
end
|
2944
|
+
|
2797
2945
|
# Creates TargetSite in a batch.
|
2798
2946
|
# @param [String] parent
|
2799
2947
|
# Required. The parent resource shared by all TargetSites being created. `
|
@@ -3653,6 +3801,45 @@ module Google
|
|
3653
3801
|
execute_or_queue_command(command, &block)
|
3654
3802
|
end
|
3655
3803
|
|
3804
|
+
# Removes the search history suggestion in an engine for a user. This will
|
3805
|
+
# remove the suggestion from being returned in the AdvancedCompleteQueryResponse.
|
3806
|
+
# recent_search_suggestions for this user. If the user searches the same
|
3807
|
+
# suggestion again, the new history will override and suggest this suggestion
|
3808
|
+
# again.
|
3809
|
+
# @param [String] completion_config
|
3810
|
+
# Required. The completion_config of the parent engine resource name for which
|
3811
|
+
# the search history suggestion is to be removed, such as `projects/*/locations/
|
3812
|
+
# global/collections/default_collection/engines/*/completionConfig`.
|
3813
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest] google_cloud_discoveryengine_v1beta_remove_suggestion_request_object
|
3814
|
+
# @param [String] fields
|
3815
|
+
# Selector specifying which fields to include in a partial response.
|
3816
|
+
# @param [String] quota_user
|
3817
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3818
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3819
|
+
# @param [Google::Apis::RequestOptions] options
|
3820
|
+
# Request-specific options
|
3821
|
+
#
|
3822
|
+
# @yield [result, err] Result & error if block supplied
|
3823
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse] parsed result object
|
3824
|
+
# @yieldparam err [StandardError] error object if request failed
|
3825
|
+
#
|
3826
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse]
|
3827
|
+
#
|
3828
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3829
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3830
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3831
|
+
def remove_project_location_collection_engine_completion_config_suggestion(completion_config, google_cloud_discoveryengine_v1beta_remove_suggestion_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3832
|
+
command = make_simple_command(:post, 'v1beta/{+completionConfig}:removeSuggestion', options)
|
3833
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest::Representation
|
3834
|
+
command.request_object = google_cloud_discoveryengine_v1beta_remove_suggestion_request_object
|
3835
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse::Representation
|
3836
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse
|
3837
|
+
command.params['completionConfig'] = completion_config unless completion_config.nil?
|
3838
|
+
command.query['fields'] = fields unless fields.nil?
|
3839
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3840
|
+
execute_or_queue_command(command, &block)
|
3841
|
+
end
|
3842
|
+
|
3656
3843
|
# Creates a Control. By default 1000 controls are allowed for a data store. A
|
3657
3844
|
# request can be submitted to adjust this limit. If the Control to create
|
3658
3845
|
# already exists, an ALREADY_EXISTS error is returned.
|
@@ -7787,6 +7974,272 @@ module Google
|
|
7787
7974
|
execute_or_queue_command(command, &block)
|
7788
7975
|
end
|
7789
7976
|
|
7977
|
+
# Creates a new Identity Mapping Store.
|
7978
|
+
# @param [String] parent
|
7979
|
+
# Required. The parent collection resource name, such as `projects/`project`/
|
7980
|
+
# locations/`location``.
|
7981
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore] google_cloud_discoveryengine_v1beta_identity_mapping_store_object
|
7982
|
+
# @param [String] cmek_config_name
|
7983
|
+
# Resource name of the CmekConfig to use for protecting this Identity Mapping
|
7984
|
+
# Store.
|
7985
|
+
# @param [Boolean] disable_cmek
|
7986
|
+
# Identity Mapping Store without CMEK protections. If a default CmekConfig is
|
7987
|
+
# set for the project, setting this field will override the default CmekConfig
|
7988
|
+
# as well.
|
7989
|
+
# @param [String] identity_mapping_store_id
|
7990
|
+
# Required. The ID of the Identity Mapping Store to create. The ID must contain
|
7991
|
+
# only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The
|
7992
|
+
# maximum length is 63 characters.
|
7993
|
+
# @param [String] fields
|
7994
|
+
# Selector specifying which fields to include in a partial response.
|
7995
|
+
# @param [String] quota_user
|
7996
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7997
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7998
|
+
# @param [Google::Apis::RequestOptions] options
|
7999
|
+
# Request-specific options
|
8000
|
+
#
|
8001
|
+
# @yield [result, err] Result & error if block supplied
|
8002
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore] parsed result object
|
8003
|
+
# @yieldparam err [StandardError] error object if request failed
|
8004
|
+
#
|
8005
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore]
|
8006
|
+
#
|
8007
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8008
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8009
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8010
|
+
def create_project_location_identity_mapping_store(parent, google_cloud_discoveryengine_v1beta_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)
|
8011
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/identityMappingStores', options)
|
8012
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore::Representation
|
8013
|
+
command.request_object = google_cloud_discoveryengine_v1beta_identity_mapping_store_object
|
8014
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore::Representation
|
8015
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore
|
8016
|
+
command.params['parent'] = parent unless parent.nil?
|
8017
|
+
command.query['cmekConfigName'] = cmek_config_name unless cmek_config_name.nil?
|
8018
|
+
command.query['disableCmek'] = disable_cmek unless disable_cmek.nil?
|
8019
|
+
command.query['identityMappingStoreId'] = identity_mapping_store_id unless identity_mapping_store_id.nil?
|
8020
|
+
command.query['fields'] = fields unless fields.nil?
|
8021
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8022
|
+
execute_or_queue_command(command, &block)
|
8023
|
+
end
|
8024
|
+
|
8025
|
+
# Deletes the Identity Mapping Store.
|
8026
|
+
# @param [String] name
|
8027
|
+
# Required. The name of the Identity Mapping Store to delete. Format: `projects/`
|
8028
|
+
# project`/locations/`location`/identityMappingStores/`identityMappingStore``
|
8029
|
+
# @param [String] fields
|
8030
|
+
# Selector specifying which fields to include in a partial response.
|
8031
|
+
# @param [String] quota_user
|
8032
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8033
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8034
|
+
# @param [Google::Apis::RequestOptions] options
|
8035
|
+
# Request-specific options
|
8036
|
+
#
|
8037
|
+
# @yield [result, err] Result & error if block supplied
|
8038
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
8039
|
+
# @yieldparam err [StandardError] error object if request failed
|
8040
|
+
#
|
8041
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
8042
|
+
#
|
8043
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8044
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8045
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8046
|
+
def delete_project_location_identity_mapping_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
8047
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
8048
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
8049
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
8050
|
+
command.params['name'] = name unless name.nil?
|
8051
|
+
command.query['fields'] = fields unless fields.nil?
|
8052
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8053
|
+
execute_or_queue_command(command, &block)
|
8054
|
+
end
|
8055
|
+
|
8056
|
+
# Gets the Identity Mapping Store.
|
8057
|
+
# @param [String] name
|
8058
|
+
# Required. The name of the Identity Mapping Store to get. Format: `projects/`
|
8059
|
+
# project`/locations/`location`/identityMappingStores/`identityMappingStore``
|
8060
|
+
# @param [String] fields
|
8061
|
+
# Selector specifying which fields to include in a partial response.
|
8062
|
+
# @param [String] quota_user
|
8063
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8064
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8065
|
+
# @param [Google::Apis::RequestOptions] options
|
8066
|
+
# Request-specific options
|
8067
|
+
#
|
8068
|
+
# @yield [result, err] Result & error if block supplied
|
8069
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore] parsed result object
|
8070
|
+
# @yieldparam err [StandardError] error object if request failed
|
8071
|
+
#
|
8072
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore]
|
8073
|
+
#
|
8074
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8075
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8076
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8077
|
+
def get_project_location_identity_mapping_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
8078
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
8079
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore::Representation
|
8080
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore
|
8081
|
+
command.params['name'] = name unless name.nil?
|
8082
|
+
command.query['fields'] = fields unless fields.nil?
|
8083
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8084
|
+
execute_or_queue_command(command, &block)
|
8085
|
+
end
|
8086
|
+
|
8087
|
+
# Imports a list of Identity Mapping Entries to an Identity Mapping Store.
|
8088
|
+
# @param [String] identity_mapping_store
|
8089
|
+
# Required. The name of the Identity Mapping Store to import Identity Mapping
|
8090
|
+
# Entries to. Format: `projects/`project`/locations/`location`/
|
8091
|
+
# identityMappingStores/`identityMappingStore``
|
8092
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest] google_cloud_discoveryengine_v1beta_import_identity_mappings_request_object
|
8093
|
+
# @param [String] fields
|
8094
|
+
# Selector specifying which fields to include in a partial response.
|
8095
|
+
# @param [String] quota_user
|
8096
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8097
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8098
|
+
# @param [Google::Apis::RequestOptions] options
|
8099
|
+
# Request-specific options
|
8100
|
+
#
|
8101
|
+
# @yield [result, err] Result & error if block supplied
|
8102
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
8103
|
+
# @yieldparam err [StandardError] error object if request failed
|
8104
|
+
#
|
8105
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
8106
|
+
#
|
8107
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8108
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8109
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8110
|
+
def import_project_location_identity_mapping_store_identity_mappings(identity_mapping_store, google_cloud_discoveryengine_v1beta_import_identity_mappings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
8111
|
+
command = make_simple_command(:post, 'v1beta/{+identityMappingStore}:importIdentityMappings', options)
|
8112
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest::Representation
|
8113
|
+
command.request_object = google_cloud_discoveryengine_v1beta_import_identity_mappings_request_object
|
8114
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
8115
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
8116
|
+
command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
|
8117
|
+
command.query['fields'] = fields unless fields.nil?
|
8118
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8119
|
+
execute_or_queue_command(command, &block)
|
8120
|
+
end
|
8121
|
+
|
8122
|
+
# Lists all Identity Mapping Stores.
|
8123
|
+
# @param [String] parent
|
8124
|
+
# Required. The parent of the Identity Mapping Stores to list. Format: `projects/
|
8125
|
+
# `project`/locations/`location``.
|
8126
|
+
# @param [Fixnum] page_size
|
8127
|
+
# Maximum number of IdentityMappingStores to return. If unspecified, defaults to
|
8128
|
+
# 100. The maximum allowed value is 1000. Values above 1000 will be coerced to
|
8129
|
+
# 1000.
|
8130
|
+
# @param [String] page_token
|
8131
|
+
# A page token, received from a previous `ListIdentityMappingStores` call.
|
8132
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
8133
|
+
# parameters provided to `ListIdentityMappingStores` must match the call that
|
8134
|
+
# provided the page token.
|
8135
|
+
# @param [String] fields
|
8136
|
+
# Selector specifying which fields to include in a partial response.
|
8137
|
+
# @param [String] quota_user
|
8138
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8139
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8140
|
+
# @param [Google::Apis::RequestOptions] options
|
8141
|
+
# Request-specific options
|
8142
|
+
#
|
8143
|
+
# @yield [result, err] Result & error if block supplied
|
8144
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse] parsed result object
|
8145
|
+
# @yieldparam err [StandardError] error object if request failed
|
8146
|
+
#
|
8147
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse]
|
8148
|
+
#
|
8149
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8150
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8151
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8152
|
+
def list_project_location_identity_mapping_stores(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
8153
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/identityMappingStores', options)
|
8154
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse::Representation
|
8155
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse
|
8156
|
+
command.params['parent'] = parent unless parent.nil?
|
8157
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
8158
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
8159
|
+
command.query['fields'] = fields unless fields.nil?
|
8160
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8161
|
+
execute_or_queue_command(command, &block)
|
8162
|
+
end
|
8163
|
+
|
8164
|
+
# Lists Identity Mappings in an Identity Mapping Store.
|
8165
|
+
# @param [String] identity_mapping_store
|
8166
|
+
# Required. The name of the Identity Mapping Store to list Identity Mapping
|
8167
|
+
# Entries in. Format: `projects/`project`/locations/`location`/
|
8168
|
+
# identityMappingStores/`identityMappingStore``
|
8169
|
+
# @param [Fixnum] page_size
|
8170
|
+
# Maximum number of IdentityMappings to return. If unspecified, defaults to 2000.
|
8171
|
+
# The maximum allowed value is 10000. Values above 10000 will be coerced to
|
8172
|
+
# 10000.
|
8173
|
+
# @param [String] page_token
|
8174
|
+
# A page token, received from a previous `ListIdentityMappings` call. Provide
|
8175
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
8176
|
+
# provided to `ListIdentityMappings` must match the call that provided the page
|
8177
|
+
# token.
|
8178
|
+
# @param [String] fields
|
8179
|
+
# Selector specifying which fields to include in a partial response.
|
8180
|
+
# @param [String] quota_user
|
8181
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8182
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8183
|
+
# @param [Google::Apis::RequestOptions] options
|
8184
|
+
# Request-specific options
|
8185
|
+
#
|
8186
|
+
# @yield [result, err] Result & error if block supplied
|
8187
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse] parsed result object
|
8188
|
+
# @yieldparam err [StandardError] error object if request failed
|
8189
|
+
#
|
8190
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse]
|
8191
|
+
#
|
8192
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8193
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8194
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8195
|
+
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)
|
8196
|
+
command = make_simple_command(:get, 'v1beta/{+identityMappingStore}:listIdentityMappings', options)
|
8197
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse::Representation
|
8198
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse
|
8199
|
+
command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
|
8200
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
8201
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
8202
|
+
command.query['fields'] = fields unless fields.nil?
|
8203
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8204
|
+
execute_or_queue_command(command, &block)
|
8205
|
+
end
|
8206
|
+
|
8207
|
+
# Purges specified or all Identity Mapping Entries from an Identity Mapping
|
8208
|
+
# Store.
|
8209
|
+
# @param [String] identity_mapping_store
|
8210
|
+
# Required. The name of the Identity Mapping Store to purge Identity Mapping
|
8211
|
+
# Entries from. Format: `projects/`project`/locations/`location`/
|
8212
|
+
# identityMappingStores/`identityMappingStore``
|
8213
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest] google_cloud_discoveryengine_v1beta_purge_identity_mappings_request_object
|
8214
|
+
# @param [String] fields
|
8215
|
+
# Selector specifying which fields to include in a partial response.
|
8216
|
+
# @param [String] quota_user
|
8217
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8218
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8219
|
+
# @param [Google::Apis::RequestOptions] options
|
8220
|
+
# Request-specific options
|
8221
|
+
#
|
8222
|
+
# @yield [result, err] Result & error if block supplied
|
8223
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
8224
|
+
# @yieldparam err [StandardError] error object if request failed
|
8225
|
+
#
|
8226
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
8227
|
+
#
|
8228
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8229
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8230
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8231
|
+
def purge_project_location_identity_mapping_store_identity_mappings(identity_mapping_store, google_cloud_discoveryengine_v1beta_purge_identity_mappings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
8232
|
+
command = make_simple_command(:post, 'v1beta/{+identityMappingStore}:purgeIdentityMappings', options)
|
8233
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest::Representation
|
8234
|
+
command.request_object = google_cloud_discoveryengine_v1beta_purge_identity_mappings_request_object
|
8235
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
8236
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
8237
|
+
command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
|
8238
|
+
command.query['fields'] = fields unless fields.nil?
|
8239
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8240
|
+
execute_or_queue_command(command, &block)
|
8241
|
+
end
|
8242
|
+
|
7790
8243
|
# Gets the latest state of a long-running operation. Clients can use this method
|
7791
8244
|
# to poll the operation result at intervals as recommended by the API service.
|
7792
8245
|
# @param [String] name
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-discoveryengine_v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.56.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_v1beta/CHANGELOG.md
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.56.0
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
|
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 V1beta
|
79
79
|
test_files: []
|