google-apis-discoveryengine_v1alpha 0.53.0 → 0.55.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.
@@ -51,6 +51,50 @@ module Google
51
51
  @batch_path = 'batch'
52
52
  end
53
53
 
54
+ # Uploads a file for Notebook LM to use. Creates a Source.
55
+ # @param [String] parent
56
+ # Required. The parent resource where the sources will be created. Format:
57
+ # projects/`project`/locations/`location`/notebooks/`notebook`
58
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaUploadSourceFileRequest] google_cloud_notebooklm_v1alpha_upload_source_file_request_object
59
+ # @param [String] fields
60
+ # Selector specifying which fields to include in a partial response.
61
+ # @param [String] quota_user
62
+ # Available to use for quota purposes for server-side applications. Can be any
63
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
64
+ # @param [IO, String] upload_source
65
+ # IO stream or filename containing content to upload
66
+ # @param [String] content_type
67
+ # Content type of the uploaded content.
68
+ # @param [Google::Apis::RequestOptions] options
69
+ # Request-specific options
70
+ #
71
+ # @yield [result, err] Result & error if block supplied
72
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaUploadSourceFileResponse] parsed result object
73
+ # @yieldparam err [StandardError] error object if request failed
74
+ #
75
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaUploadSourceFileResponse]
76
+ #
77
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
78
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
79
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
80
+ def upload_medium(parent, google_cloud_notebooklm_v1alpha_upload_source_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
81
+ if upload_source.nil?
82
+ command = make_simple_command(:post, 'v1alpha/{+parent}/sources:uploadFile', options)
83
+ else
84
+ command = make_upload_command(:post, 'v1alpha/{+parent}/sources:uploadFile', options)
85
+ command.upload_source = upload_source
86
+ command.upload_content_type = content_type
87
+ end
88
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaUploadSourceFileRequest::Representation
89
+ command.request_object = google_cloud_notebooklm_v1alpha_upload_source_file_request_object
90
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaUploadSourceFileResponse::Representation
91
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaUploadSourceFileResponse
92
+ command.params['parent'] = parent unless parent.nil?
93
+ command.query['fields'] = fields unless fields.nil?
94
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
95
+ execute_or_queue_command(command, &block)
96
+ end
97
+
54
98
  # Gets a Project. Returns NOT_FOUND when the project is not yet created.
55
99
  # @param [String] name
56
100
  # Required. Full resource name of a Project, such as `projects/`
@@ -189,39 +233,6 @@ module Google
189
233
  execute_or_queue_command(command, &block)
190
234
  end
191
235
 
192
- # Generates grounded content.
193
- # @param [String] location
194
- # Required. Location resource. Format: `projects/`project`/locations/`location``.
195
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest] google_cloud_discoveryengine_v1alpha_generate_grounded_content_request_object
196
- # @param [String] fields
197
- # Selector specifying which fields to include in a partial response.
198
- # @param [String] quota_user
199
- # Available to use for quota purposes for server-side applications. Can be any
200
- # arbitrary string assigned to a user, but should not exceed 40 characters.
201
- # @param [Google::Apis::RequestOptions] options
202
- # Request-specific options
203
- #
204
- # @yield [result, err] Result & error if block supplied
205
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse] parsed result object
206
- # @yieldparam err [StandardError] error object if request failed
207
- #
208
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse]
209
- #
210
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
211
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
212
- # @raise [Google::Apis::AuthorizationError] Authorization is required
213
- def generate_project_location_grounded_content(location, google_cloud_discoveryengine_v1alpha_generate_grounded_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
214
- command = make_simple_command(:post, 'v1alpha/{+location}:generateGroundedContent', options)
215
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest::Representation
216
- command.request_object = google_cloud_discoveryengine_v1alpha_generate_grounded_content_request_object
217
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse::Representation
218
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse
219
- command.params['location'] = location unless location.nil?
220
- command.query['fields'] = fields unless fields.nil?
221
- command.query['quotaUser'] = quota_user unless quota_user.nil?
222
- execute_or_queue_command(command, &block)
223
- end
224
-
225
236
  # Gets the AclConfig.
226
237
  # @param [String] name
227
238
  # Required. Resource name of AclConfig, such as `projects/*/locations/*/
@@ -477,9 +488,9 @@ module Google
477
488
  # method will also conduct location validation on the provided cmekConfig to
478
489
  # make sure the key is valid and can be used in the selected location.
479
490
  # @param [String] name
480
- # Required. Name of the CmekConfig, of the form `projects/`project`/locations/`
481
- # location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/`
482
- # cmekConfig``.
491
+ # Required. The name of the CmekConfig of the form `projects/`project`/locations/
492
+ # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
493
+ # `cmekConfig``.
483
494
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig] google_cloud_discoveryengine_v1alpha_cmek_config_object
484
495
  # @param [Boolean] set_default
485
496
  # Set the following CmekConfig as the default to be used for child resources if
@@ -514,6 +525,37 @@ module Google
514
525
  execute_or_queue_command(command, &block)
515
526
  end
516
527
 
528
+ # De-provisions a CmekConfig.
529
+ # @param [String] name
530
+ # Required. The resource name of the CmekConfig to delete, such as `projects/`
531
+ # project`/locations/`location`/cmekConfigs/`cmek_config``.
532
+ # @param [String] fields
533
+ # Selector specifying which fields to include in a partial response.
534
+ # @param [String] quota_user
535
+ # Available to use for quota purposes for server-side applications. Can be any
536
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
537
+ # @param [Google::Apis::RequestOptions] options
538
+ # Request-specific options
539
+ #
540
+ # @yield [result, err] Result & error if block supplied
541
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
542
+ # @yieldparam err [StandardError] error object if request failed
543
+ #
544
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
545
+ #
546
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
547
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
548
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
549
+ def delete_project_location_cmek_config(name, fields: nil, quota_user: nil, options: nil, &block)
550
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
551
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
552
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
553
+ command.params['name'] = name unless name.nil?
554
+ command.query['fields'] = fields unless fields.nil?
555
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
556
+ execute_or_queue_command(command, &block)
557
+ end
558
+
517
559
  # Gets the CmekConfig.
518
560
  # @param [String] name
519
561
  # Required. Resource name of CmekConfig, such as `projects/*/locations/*/
@@ -584,9 +626,9 @@ module Google
584
626
  # method will also conduct location validation on the provided cmekConfig to
585
627
  # make sure the key is valid and can be used in the selected location.
586
628
  # @param [String] name
587
- # Required. Name of the CmekConfig, of the form `projects/`project`/locations/`
588
- # location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/`
589
- # cmekConfig``.
629
+ # Required. The name of the CmekConfig of the form `projects/`project`/locations/
630
+ # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
631
+ # `cmekConfig``.
590
632
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig] google_cloud_discoveryengine_v1alpha_cmek_config_object
591
633
  # @param [Boolean] set_default
592
634
  # Set the following CmekConfig as the default to be used for child resources if
@@ -3863,6 +3905,40 @@ module Google
3863
3905
  execute_or_queue_command(command, &block)
3864
3906
  end
3865
3907
 
3908
+ # Fetch Sitemaps in a DataStore.
3909
+ # @param [String] parent
3910
+ # Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
3911
+ # locations/*/collections/*/dataStores/*/siteSearchEngine`.
3912
+ # @param [Array<String>, String] matcher_uris_matcher_uris
3913
+ # The Sitemap uris.
3914
+ # @param [String] fields
3915
+ # Selector specifying which fields to include in a partial response.
3916
+ # @param [String] quota_user
3917
+ # Available to use for quota purposes for server-side applications. Can be any
3918
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3919
+ # @param [Google::Apis::RequestOptions] options
3920
+ # Request-specific options
3921
+ #
3922
+ # @yield [result, err] Result & error if block supplied
3923
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse] parsed result object
3924
+ # @yieldparam err [StandardError] error object if request failed
3925
+ #
3926
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse]
3927
+ #
3928
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3929
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3930
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3931
+ 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)
3932
+ command = make_simple_command(:get, 'v1alpha/{+parent}/sitemaps:fetch', options)
3933
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse::Representation
3934
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse
3935
+ command.params['parent'] = parent unless parent.nil?
3936
+ command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
3937
+ command.query['fields'] = fields unless fields.nil?
3938
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3939
+ execute_or_queue_command(command, &block)
3940
+ end
3941
+
3866
3942
  # Creates TargetSite in a batch.
3867
3943
  # @param [String] parent
3868
3944
  # Required. The parent resource shared by all TargetSites being created. `
@@ -4394,6 +4470,45 @@ module Google
4394
4470
  execute_or_queue_command(command, &block)
4395
4471
  end
4396
4472
 
4473
+ # Gets a WidgetConfig.
4474
+ # @param [String] name
4475
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
4476
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
4477
+ # widgetConfigs/`widget_config_id``
4478
+ # @param [Boolean] accept_cache
4479
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
4480
+ # to true, recent changes on widget configs may take a few minutes to reflect on
4481
+ # the end user's view. It's recommended to set to true for maturely developed
4482
+ # widgets, as it improves widget performance. Set to false to see changes
4483
+ # reflected in prod right away, if your widget is under development.
4484
+ # @param [String] fields
4485
+ # Selector specifying which fields to include in a partial response.
4486
+ # @param [String] quota_user
4487
+ # Available to use for quota purposes for server-side applications. Can be any
4488
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4489
+ # @param [Google::Apis::RequestOptions] options
4490
+ # Request-specific options
4491
+ #
4492
+ # @yield [result, err] Result & error if block supplied
4493
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
4494
+ # @yieldparam err [StandardError] error object if request failed
4495
+ #
4496
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
4497
+ #
4498
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4499
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4500
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4501
+ def get_project_location_collection_data_store_widget_config(name, accept_cache: nil, fields: nil, quota_user: nil, options: nil, &block)
4502
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4503
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
4504
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
4505
+ command.params['name'] = name unless name.nil?
4506
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
4507
+ command.query['fields'] = fields unless fields.nil?
4508
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4509
+ execute_or_queue_command(command, &block)
4510
+ end
4511
+
4397
4512
  # Creates a Engine.
4398
4513
  # @param [String] parent
4399
4514
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -4722,6 +4837,45 @@ module Google
4722
4837
  execute_or_queue_command(command, &block)
4723
4838
  end
4724
4839
 
4840
+ # Removes the search history suggestion in an engine for a user. This will
4841
+ # remove the suggestion from being returned in the AdvancedCompleteQueryResponse.
4842
+ # recent_search_suggestions for this user. If the user searches the same
4843
+ # suggestion again, the new history will override and suggest this suggestion
4844
+ # again.
4845
+ # @param [String] completion_config
4846
+ # Required. The completion_config of the parent engine resource name for which
4847
+ # the search history suggestion is to be removed, such as `projects/*/locations/
4848
+ # global/collections/default_collection/engines/*/completionConfig`.
4849
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest] google_cloud_discoveryengine_v1alpha_remove_suggestion_request_object
4850
+ # @param [String] fields
4851
+ # Selector specifying which fields to include in a partial response.
4852
+ # @param [String] quota_user
4853
+ # Available to use for quota purposes for server-side applications. Can be any
4854
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4855
+ # @param [Google::Apis::RequestOptions] options
4856
+ # Request-specific options
4857
+ #
4858
+ # @yield [result, err] Result & error if block supplied
4859
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse] parsed result object
4860
+ # @yieldparam err [StandardError] error object if request failed
4861
+ #
4862
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse]
4863
+ #
4864
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4865
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4866
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4867
+ def remove_project_location_collection_engine_completion_config_suggestion(completion_config, google_cloud_discoveryengine_v1alpha_remove_suggestion_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4868
+ command = make_simple_command(:post, 'v1alpha/{+completionConfig}:removeSuggestion', options)
4869
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest::Representation
4870
+ command.request_object = google_cloud_discoveryengine_v1alpha_remove_suggestion_request_object
4871
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse::Representation
4872
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse
4873
+ command.params['completionConfig'] = completion_config unless completion_config.nil?
4874
+ command.query['fields'] = fields unless fields.nil?
4875
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4876
+ execute_or_queue_command(command, &block)
4877
+ end
4878
+
4725
4879
  # Creates a Control. By default 1000 controls are allowed for a data store. A
4726
4880
  # request can be submitted to adjust this limit. If the Control to create
4727
4881
  # already exists, an ALREADY_EXISTS error is returned.
@@ -5753,6 +5907,45 @@ module Google
5753
5907
  execute_or_queue_command(command, &block)
5754
5908
  end
5755
5909
 
5910
+ # Gets a WidgetConfig.
5911
+ # @param [String] name
5912
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
5913
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
5914
+ # widgetConfigs/`widget_config_id``
5915
+ # @param [Boolean] accept_cache
5916
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
5917
+ # to true, recent changes on widget configs may take a few minutes to reflect on
5918
+ # the end user's view. It's recommended to set to true for maturely developed
5919
+ # widgets, as it improves widget performance. Set to false to see changes
5920
+ # reflected in prod right away, if your widget is under development.
5921
+ # @param [String] fields
5922
+ # Selector specifying which fields to include in a partial response.
5923
+ # @param [String] quota_user
5924
+ # Available to use for quota purposes for server-side applications. Can be any
5925
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5926
+ # @param [Google::Apis::RequestOptions] options
5927
+ # Request-specific options
5928
+ #
5929
+ # @yield [result, err] Result & error if block supplied
5930
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
5931
+ # @yieldparam err [StandardError] error object if request failed
5932
+ #
5933
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
5934
+ #
5935
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5936
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5937
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5938
+ def get_project_location_collection_engine_widget_config(name, accept_cache: nil, fields: nil, quota_user: nil, options: nil, &block)
5939
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
5940
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
5941
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
5942
+ command.params['name'] = name unless name.nil?
5943
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
5944
+ command.query['fields'] = fields unless fields.nil?
5945
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5946
+ execute_or_queue_command(command, &block)
5947
+ end
5948
+
5756
5949
  # Gets the latest state of a long-running operation. Clients can use this method
5757
5950
  # to poll the operation result at intervals as recommended by the API service.
5758
5951
  # @param [String] name
@@ -8825,6 +9018,45 @@ module Google
8825
9018
  execute_or_queue_command(command, &block)
8826
9019
  end
8827
9020
 
9021
+ # Gets a WidgetConfig.
9022
+ # @param [String] name
9023
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
9024
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
9025
+ # widgetConfigs/`widget_config_id``
9026
+ # @param [Boolean] accept_cache
9027
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
9028
+ # to true, recent changes on widget configs may take a few minutes to reflect on
9029
+ # the end user's view. It's recommended to set to true for maturely developed
9030
+ # widgets, as it improves widget performance. Set to false to see changes
9031
+ # reflected in prod right away, if your widget is under development.
9032
+ # @param [String] fields
9033
+ # Selector specifying which fields to include in a partial response.
9034
+ # @param [String] quota_user
9035
+ # Available to use for quota purposes for server-side applications. Can be any
9036
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9037
+ # @param [Google::Apis::RequestOptions] options
9038
+ # Request-specific options
9039
+ #
9040
+ # @yield [result, err] Result & error if block supplied
9041
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
9042
+ # @yieldparam err [StandardError] error object if request failed
9043
+ #
9044
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
9045
+ #
9046
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9047
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9048
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9049
+ def get_project_location_data_store_widget_config(name, accept_cache: nil, fields: nil, quota_user: nil, options: nil, &block)
9050
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
9051
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
9052
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
9053
+ command.params['name'] = name unless name.nil?
9054
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
9055
+ command.query['fields'] = fields unless fields.nil?
9056
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9057
+ execute_or_queue_command(command, &block)
9058
+ end
9059
+
8828
9060
  # Creates a Evaluation. Upon creation, the evaluation will be automatically
8829
9061
  # triggered and begin execution.
8830
9062
  # @param [String] parent
@@ -9051,6 +9283,272 @@ module Google
9051
9283
  execute_or_queue_command(command, &block)
9052
9284
  end
9053
9285
 
9286
+ # Creates a new Identity Mapping Store.
9287
+ # @param [String] parent
9288
+ # Required. The parent collection resource name, such as `projects/`project`/
9289
+ # locations/`location``.
9290
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore] google_cloud_discoveryengine_v1alpha_identity_mapping_store_object
9291
+ # @param [String] cmek_config_name
9292
+ # Resource name of the CmekConfig to use for protecting this Identity Mapping
9293
+ # Store.
9294
+ # @param [Boolean] disable_cmek
9295
+ # Identity Mapping Store without CMEK protections. If a default CmekConfig is
9296
+ # set for the project, setting this field will override the default CmekConfig
9297
+ # as well.
9298
+ # @param [String] identity_mapping_store_id
9299
+ # Required. The ID of the Identity Mapping Store to create. The ID must contain
9300
+ # only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The
9301
+ # maximum length is 63 characters.
9302
+ # @param [String] fields
9303
+ # Selector specifying which fields to include in a partial response.
9304
+ # @param [String] quota_user
9305
+ # Available to use for quota purposes for server-side applications. Can be any
9306
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9307
+ # @param [Google::Apis::RequestOptions] options
9308
+ # Request-specific options
9309
+ #
9310
+ # @yield [result, err] Result & error if block supplied
9311
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore] parsed result object
9312
+ # @yieldparam err [StandardError] error object if request failed
9313
+ #
9314
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore]
9315
+ #
9316
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9317
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9318
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9319
+ def create_project_location_identity_mapping_store(parent, google_cloud_discoveryengine_v1alpha_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)
9320
+ command = make_simple_command(:post, 'v1alpha/{+parent}/identityMappingStores', options)
9321
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore::Representation
9322
+ command.request_object = google_cloud_discoveryengine_v1alpha_identity_mapping_store_object
9323
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore::Representation
9324
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore
9325
+ command.params['parent'] = parent unless parent.nil?
9326
+ command.query['cmekConfigName'] = cmek_config_name unless cmek_config_name.nil?
9327
+ command.query['disableCmek'] = disable_cmek unless disable_cmek.nil?
9328
+ command.query['identityMappingStoreId'] = identity_mapping_store_id unless identity_mapping_store_id.nil?
9329
+ command.query['fields'] = fields unless fields.nil?
9330
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9331
+ execute_or_queue_command(command, &block)
9332
+ end
9333
+
9334
+ # Deletes the Identity Mapping Store.
9335
+ # @param [String] name
9336
+ # Required. The name of the Identity Mapping Store to delete. Format: `projects/`
9337
+ # project`/locations/`location`/identityMappingStores/`identityMappingStore``
9338
+ # @param [String] fields
9339
+ # Selector specifying which fields to include in a partial response.
9340
+ # @param [String] quota_user
9341
+ # Available to use for quota purposes for server-side applications. Can be any
9342
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9343
+ # @param [Google::Apis::RequestOptions] options
9344
+ # Request-specific options
9345
+ #
9346
+ # @yield [result, err] Result & error if block supplied
9347
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
9348
+ # @yieldparam err [StandardError] error object if request failed
9349
+ #
9350
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
9351
+ #
9352
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9353
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9354
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9355
+ def delete_project_location_identity_mapping_store(name, fields: nil, quota_user: nil, options: nil, &block)
9356
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
9357
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
9358
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
9359
+ command.params['name'] = name unless name.nil?
9360
+ command.query['fields'] = fields unless fields.nil?
9361
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9362
+ execute_or_queue_command(command, &block)
9363
+ end
9364
+
9365
+ # Gets the Identity Mapping Store.
9366
+ # @param [String] name
9367
+ # Required. The name of the Identity Mapping Store to get. Format: `projects/`
9368
+ # project`/locations/`location`/identityMappingStores/`identityMappingStore``
9369
+ # @param [String] fields
9370
+ # Selector specifying which fields to include in a partial response.
9371
+ # @param [String] quota_user
9372
+ # Available to use for quota purposes for server-side applications. Can be any
9373
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9374
+ # @param [Google::Apis::RequestOptions] options
9375
+ # Request-specific options
9376
+ #
9377
+ # @yield [result, err] Result & error if block supplied
9378
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore] parsed result object
9379
+ # @yieldparam err [StandardError] error object if request failed
9380
+ #
9381
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore]
9382
+ #
9383
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9384
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9385
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9386
+ def get_project_location_identity_mapping_store(name, fields: nil, quota_user: nil, options: nil, &block)
9387
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
9388
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore::Representation
9389
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore
9390
+ command.params['name'] = name unless name.nil?
9391
+ command.query['fields'] = fields unless fields.nil?
9392
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9393
+ execute_or_queue_command(command, &block)
9394
+ end
9395
+
9396
+ # Imports a list of Identity Mapping Entries to an Identity Mapping Store.
9397
+ # @param [String] identity_mapping_store
9398
+ # Required. The name of the Identity Mapping Store to import Identity Mapping
9399
+ # Entries to. Format: `projects/`project`/locations/`location`/
9400
+ # identityMappingStores/`identityMappingStore``
9401
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest] google_cloud_discoveryengine_v1alpha_import_identity_mappings_request_object
9402
+ # @param [String] fields
9403
+ # Selector specifying which fields to include in a partial response.
9404
+ # @param [String] quota_user
9405
+ # Available to use for quota purposes for server-side applications. Can be any
9406
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9407
+ # @param [Google::Apis::RequestOptions] options
9408
+ # Request-specific options
9409
+ #
9410
+ # @yield [result, err] Result & error if block supplied
9411
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
9412
+ # @yieldparam err [StandardError] error object if request failed
9413
+ #
9414
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
9415
+ #
9416
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9417
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9418
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9419
+ def import_project_location_identity_mapping_store_identity_mappings(identity_mapping_store, google_cloud_discoveryengine_v1alpha_import_identity_mappings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
9420
+ command = make_simple_command(:post, 'v1alpha/{+identityMappingStore}:importIdentityMappings', options)
9421
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest::Representation
9422
+ command.request_object = google_cloud_discoveryengine_v1alpha_import_identity_mappings_request_object
9423
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
9424
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
9425
+ command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
9426
+ command.query['fields'] = fields unless fields.nil?
9427
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9428
+ execute_or_queue_command(command, &block)
9429
+ end
9430
+
9431
+ # Lists all Identity Mapping Stores.
9432
+ # @param [String] parent
9433
+ # Required. The parent of the Identity Mapping Stores to list. Format: `projects/
9434
+ # `project`/locations/`location``.
9435
+ # @param [Fixnum] page_size
9436
+ # Maximum number of IdentityMappingStores to return. If unspecified, defaults to
9437
+ # 100. The maximum allowed value is 1000. Values above 1000 will be coerced to
9438
+ # 1000.
9439
+ # @param [String] page_token
9440
+ # A page token, received from a previous `ListIdentityMappingStores` call.
9441
+ # Provide this to retrieve the subsequent page. When paginating, all other
9442
+ # parameters provided to `ListIdentityMappingStores` must match the call that
9443
+ # provided the page token.
9444
+ # @param [String] fields
9445
+ # Selector specifying which fields to include in a partial response.
9446
+ # @param [String] quota_user
9447
+ # Available to use for quota purposes for server-side applications. Can be any
9448
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9449
+ # @param [Google::Apis::RequestOptions] options
9450
+ # Request-specific options
9451
+ #
9452
+ # @yield [result, err] Result & error if block supplied
9453
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse] parsed result object
9454
+ # @yieldparam err [StandardError] error object if request failed
9455
+ #
9456
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse]
9457
+ #
9458
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9459
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9460
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9461
+ def list_project_location_identity_mapping_stores(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
9462
+ command = make_simple_command(:get, 'v1alpha/{+parent}/identityMappingStores', options)
9463
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse::Representation
9464
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse
9465
+ command.params['parent'] = parent unless parent.nil?
9466
+ command.query['pageSize'] = page_size unless page_size.nil?
9467
+ command.query['pageToken'] = page_token unless page_token.nil?
9468
+ command.query['fields'] = fields unless fields.nil?
9469
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9470
+ execute_or_queue_command(command, &block)
9471
+ end
9472
+
9473
+ # Lists Identity Mappings in an Identity Mapping Store.
9474
+ # @param [String] identity_mapping_store
9475
+ # Required. The name of the Identity Mapping Store to list Identity Mapping
9476
+ # Entries in. Format: `projects/`project`/locations/`location`/
9477
+ # identityMappingStores/`identityMappingStore``
9478
+ # @param [Fixnum] page_size
9479
+ # Maximum number of IdentityMappings to return. If unspecified, defaults to 2000.
9480
+ # The maximum allowed value is 10000. Values above 10000 will be coerced to
9481
+ # 10000.
9482
+ # @param [String] page_token
9483
+ # A page token, received from a previous `ListIdentityMappings` call. Provide
9484
+ # this to retrieve the subsequent page. When paginating, all other parameters
9485
+ # provided to `ListIdentityMappings` must match the call that provided the page
9486
+ # token.
9487
+ # @param [String] fields
9488
+ # Selector specifying which fields to include in a partial response.
9489
+ # @param [String] quota_user
9490
+ # Available to use for quota purposes for server-side applications. Can be any
9491
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9492
+ # @param [Google::Apis::RequestOptions] options
9493
+ # Request-specific options
9494
+ #
9495
+ # @yield [result, err] Result & error if block supplied
9496
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse] parsed result object
9497
+ # @yieldparam err [StandardError] error object if request failed
9498
+ #
9499
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse]
9500
+ #
9501
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9502
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9503
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9504
+ 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)
9505
+ command = make_simple_command(:get, 'v1alpha/{+identityMappingStore}:listIdentityMappings', options)
9506
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse::Representation
9507
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse
9508
+ command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
9509
+ command.query['pageSize'] = page_size unless page_size.nil?
9510
+ command.query['pageToken'] = page_token unless page_token.nil?
9511
+ command.query['fields'] = fields unless fields.nil?
9512
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9513
+ execute_or_queue_command(command, &block)
9514
+ end
9515
+
9516
+ # Purges specified or all Identity Mapping Entries from an Identity Mapping
9517
+ # Store.
9518
+ # @param [String] identity_mapping_store
9519
+ # Required. The name of the Identity Mapping Store to purge Identity Mapping
9520
+ # Entries from. Format: `projects/`project`/locations/`location`/
9521
+ # identityMappingStores/`identityMappingStore``
9522
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest] google_cloud_discoveryengine_v1alpha_purge_identity_mappings_request_object
9523
+ # @param [String] fields
9524
+ # Selector specifying which fields to include in a partial response.
9525
+ # @param [String] quota_user
9526
+ # Available to use for quota purposes for server-side applications. Can be any
9527
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9528
+ # @param [Google::Apis::RequestOptions] options
9529
+ # Request-specific options
9530
+ #
9531
+ # @yield [result, err] Result & error if block supplied
9532
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
9533
+ # @yieldparam err [StandardError] error object if request failed
9534
+ #
9535
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
9536
+ #
9537
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9538
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9539
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9540
+ def purge_project_location_identity_mapping_store_identity_mappings(identity_mapping_store, google_cloud_discoveryengine_v1alpha_purge_identity_mappings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
9541
+ command = make_simple_command(:post, 'v1alpha/{+identityMappingStore}:purgeIdentityMappings', options)
9542
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest::Representation
9543
+ command.request_object = google_cloud_discoveryengine_v1alpha_purge_identity_mappings_request_object
9544
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
9545
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
9546
+ command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
9547
+ command.query['fields'] = fields unless fields.nil?
9548
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9549
+ execute_or_queue_command(command, &block)
9550
+ end
9551
+
9054
9552
  # Gets the latest state of a long-running operation. Clients can use this method
9055
9553
  # to poll the operation result at intervals as recommended by the API service.
9056
9554
  # @param [String] name