google-apis-discoveryengine_v1alpha 0.53.0 → 0.54.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/`
@@ -477,9 +521,9 @@ module Google
477
521
  # method will also conduct location validation on the provided cmekConfig to
478
522
  # make sure the key is valid and can be used in the selected location.
479
523
  # @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``.
524
+ # Required. The name of the CmekConfig of the form `projects/`project`/locations/
525
+ # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
526
+ # `cmekConfig``.
483
527
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig] google_cloud_discoveryengine_v1alpha_cmek_config_object
484
528
  # @param [Boolean] set_default
485
529
  # Set the following CmekConfig as the default to be used for child resources if
@@ -514,6 +558,37 @@ module Google
514
558
  execute_or_queue_command(command, &block)
515
559
  end
516
560
 
561
+ # De-provisions a CmekConfig.
562
+ # @param [String] name
563
+ # Required. The resource name of the CmekConfig to delete, such as `projects/`
564
+ # project`/locations/`location`/cmekConfigs/`cmek_config``.
565
+ # @param [String] fields
566
+ # Selector specifying which fields to include in a partial response.
567
+ # @param [String] quota_user
568
+ # Available to use for quota purposes for server-side applications. Can be any
569
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
570
+ # @param [Google::Apis::RequestOptions] options
571
+ # Request-specific options
572
+ #
573
+ # @yield [result, err] Result & error if block supplied
574
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
575
+ # @yieldparam err [StandardError] error object if request failed
576
+ #
577
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
578
+ #
579
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
580
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
581
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
582
+ def delete_project_location_cmek_config(name, fields: nil, quota_user: nil, options: nil, &block)
583
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
584
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
585
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
586
+ command.params['name'] = name unless name.nil?
587
+ command.query['fields'] = fields unless fields.nil?
588
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
589
+ execute_or_queue_command(command, &block)
590
+ end
591
+
517
592
  # Gets the CmekConfig.
518
593
  # @param [String] name
519
594
  # Required. Resource name of CmekConfig, such as `projects/*/locations/*/
@@ -584,9 +659,9 @@ module Google
584
659
  # method will also conduct location validation on the provided cmekConfig to
585
660
  # make sure the key is valid and can be used in the selected location.
586
661
  # @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``.
662
+ # Required. The name of the CmekConfig of the form `projects/`project`/locations/
663
+ # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
664
+ # `cmekConfig``.
590
665
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig] google_cloud_discoveryengine_v1alpha_cmek_config_object
591
666
  # @param [Boolean] set_default
592
667
  # Set the following CmekConfig as the default to be used for child resources if
@@ -3863,6 +3938,40 @@ module Google
3863
3938
  execute_or_queue_command(command, &block)
3864
3939
  end
3865
3940
 
3941
+ # Fetch Sitemaps in a DataStore.
3942
+ # @param [String] parent
3943
+ # Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
3944
+ # locations/*/collections/*/dataStores/*/siteSearchEngine`.
3945
+ # @param [Array<String>, String] matcher_uris_matcher_uris
3946
+ # The Sitemap uris.
3947
+ # @param [String] fields
3948
+ # Selector specifying which fields to include in a partial response.
3949
+ # @param [String] quota_user
3950
+ # Available to use for quota purposes for server-side applications. Can be any
3951
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3952
+ # @param [Google::Apis::RequestOptions] options
3953
+ # Request-specific options
3954
+ #
3955
+ # @yield [result, err] Result & error if block supplied
3956
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse] parsed result object
3957
+ # @yieldparam err [StandardError] error object if request failed
3958
+ #
3959
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse]
3960
+ #
3961
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3962
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3963
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3964
+ 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)
3965
+ command = make_simple_command(:get, 'v1alpha/{+parent}/sitemaps:fetch', options)
3966
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse::Representation
3967
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse
3968
+ command.params['parent'] = parent unless parent.nil?
3969
+ command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
3970
+ command.query['fields'] = fields unless fields.nil?
3971
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3972
+ execute_or_queue_command(command, &block)
3973
+ end
3974
+
3866
3975
  # Creates TargetSite in a batch.
3867
3976
  # @param [String] parent
3868
3977
  # Required. The parent resource shared by all TargetSites being created. `
@@ -4394,6 +4503,45 @@ module Google
4394
4503
  execute_or_queue_command(command, &block)
4395
4504
  end
4396
4505
 
4506
+ # Gets a WidgetConfig.
4507
+ # @param [String] name
4508
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
4509
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
4510
+ # widgetConfigs/`widget_config_id``
4511
+ # @param [Boolean] accept_cache
4512
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
4513
+ # to true, recent changes on widget configs may take a few minutes to reflect on
4514
+ # the end user's view. It's recommended to set to true for maturely developed
4515
+ # widgets, as it improves widget performance. Set to false to see changes
4516
+ # reflected in prod right away, if your widget is under development.
4517
+ # @param [String] fields
4518
+ # Selector specifying which fields to include in a partial response.
4519
+ # @param [String] quota_user
4520
+ # Available to use for quota purposes for server-side applications. Can be any
4521
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4522
+ # @param [Google::Apis::RequestOptions] options
4523
+ # Request-specific options
4524
+ #
4525
+ # @yield [result, err] Result & error if block supplied
4526
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
4527
+ # @yieldparam err [StandardError] error object if request failed
4528
+ #
4529
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
4530
+ #
4531
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4532
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4533
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4534
+ def get_project_location_collection_data_store_widget_config(name, accept_cache: nil, fields: nil, quota_user: nil, options: nil, &block)
4535
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4536
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
4537
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
4538
+ command.params['name'] = name unless name.nil?
4539
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
4540
+ command.query['fields'] = fields unless fields.nil?
4541
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4542
+ execute_or_queue_command(command, &block)
4543
+ end
4544
+
4397
4545
  # Creates a Engine.
4398
4546
  # @param [String] parent
4399
4547
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -4722,6 +4870,45 @@ module Google
4722
4870
  execute_or_queue_command(command, &block)
4723
4871
  end
4724
4872
 
4873
+ # Removes the search history suggestion in an engine for a user. This will
4874
+ # remove the suggestion from being returned in the AdvancedCompleteQueryResponse.
4875
+ # recent_search_suggestions for this user. If the user searches the same
4876
+ # suggestion again, the new history will override and suggest this suggestion
4877
+ # again.
4878
+ # @param [String] completion_config
4879
+ # Required. The completion_config of the parent engine resource name for which
4880
+ # the search history suggestion is to be removed, such as `projects/*/locations/
4881
+ # global/collections/default_collection/engines/*/completionConfig`.
4882
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest] google_cloud_discoveryengine_v1alpha_remove_suggestion_request_object
4883
+ # @param [String] fields
4884
+ # Selector specifying which fields to include in a partial response.
4885
+ # @param [String] quota_user
4886
+ # Available to use for quota purposes for server-side applications. Can be any
4887
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4888
+ # @param [Google::Apis::RequestOptions] options
4889
+ # Request-specific options
4890
+ #
4891
+ # @yield [result, err] Result & error if block supplied
4892
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse] parsed result object
4893
+ # @yieldparam err [StandardError] error object if request failed
4894
+ #
4895
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse]
4896
+ #
4897
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4898
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4899
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4900
+ 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)
4901
+ command = make_simple_command(:post, 'v1alpha/{+completionConfig}:removeSuggestion', options)
4902
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest::Representation
4903
+ command.request_object = google_cloud_discoveryengine_v1alpha_remove_suggestion_request_object
4904
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse::Representation
4905
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse
4906
+ command.params['completionConfig'] = completion_config unless completion_config.nil?
4907
+ command.query['fields'] = fields unless fields.nil?
4908
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4909
+ execute_or_queue_command(command, &block)
4910
+ end
4911
+
4725
4912
  # Creates a Control. By default 1000 controls are allowed for a data store. A
4726
4913
  # request can be submitted to adjust this limit. If the Control to create
4727
4914
  # already exists, an ALREADY_EXISTS error is returned.
@@ -5753,6 +5940,45 @@ module Google
5753
5940
  execute_or_queue_command(command, &block)
5754
5941
  end
5755
5942
 
5943
+ # Gets a WidgetConfig.
5944
+ # @param [String] name
5945
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
5946
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
5947
+ # widgetConfigs/`widget_config_id``
5948
+ # @param [Boolean] accept_cache
5949
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
5950
+ # to true, recent changes on widget configs may take a few minutes to reflect on
5951
+ # the end user's view. It's recommended to set to true for maturely developed
5952
+ # widgets, as it improves widget performance. Set to false to see changes
5953
+ # reflected in prod right away, if your widget is under development.
5954
+ # @param [String] fields
5955
+ # Selector specifying which fields to include in a partial response.
5956
+ # @param [String] quota_user
5957
+ # Available to use for quota purposes for server-side applications. Can be any
5958
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5959
+ # @param [Google::Apis::RequestOptions] options
5960
+ # Request-specific options
5961
+ #
5962
+ # @yield [result, err] Result & error if block supplied
5963
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
5964
+ # @yieldparam err [StandardError] error object if request failed
5965
+ #
5966
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
5967
+ #
5968
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5969
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5970
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5971
+ def get_project_location_collection_engine_widget_config(name, accept_cache: nil, fields: nil, quota_user: nil, options: nil, &block)
5972
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
5973
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
5974
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
5975
+ command.params['name'] = name unless name.nil?
5976
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
5977
+ command.query['fields'] = fields unless fields.nil?
5978
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5979
+ execute_or_queue_command(command, &block)
5980
+ end
5981
+
5756
5982
  # Gets the latest state of a long-running operation. Clients can use this method
5757
5983
  # to poll the operation result at intervals as recommended by the API service.
5758
5984
  # @param [String] name
@@ -8825,6 +9051,45 @@ module Google
8825
9051
  execute_or_queue_command(command, &block)
8826
9052
  end
8827
9053
 
9054
+ # Gets a WidgetConfig.
9055
+ # @param [String] name
9056
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
9057
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
9058
+ # widgetConfigs/`widget_config_id``
9059
+ # @param [Boolean] accept_cache
9060
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
9061
+ # to true, recent changes on widget configs may take a few minutes to reflect on
9062
+ # the end user's view. It's recommended to set to true for maturely developed
9063
+ # widgets, as it improves widget performance. Set to false to see changes
9064
+ # reflected in prod right away, if your widget is under development.
9065
+ # @param [String] fields
9066
+ # Selector specifying which fields to include in a partial response.
9067
+ # @param [String] quota_user
9068
+ # Available to use for quota purposes for server-side applications. Can be any
9069
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9070
+ # @param [Google::Apis::RequestOptions] options
9071
+ # Request-specific options
9072
+ #
9073
+ # @yield [result, err] Result & error if block supplied
9074
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
9075
+ # @yieldparam err [StandardError] error object if request failed
9076
+ #
9077
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
9078
+ #
9079
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9080
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9081
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9082
+ def get_project_location_data_store_widget_config(name, accept_cache: nil, fields: nil, quota_user: nil, options: nil, &block)
9083
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
9084
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
9085
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
9086
+ command.params['name'] = name unless name.nil?
9087
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
9088
+ command.query['fields'] = fields unless fields.nil?
9089
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9090
+ execute_or_queue_command(command, &block)
9091
+ end
9092
+
8828
9093
  # Creates a Evaluation. Upon creation, the evaluation will be automatically
8829
9094
  # triggered and begin execution.
8830
9095
  # @param [String] parent
@@ -9051,6 +9316,272 @@ module Google
9051
9316
  execute_or_queue_command(command, &block)
9052
9317
  end
9053
9318
 
9319
+ # Creates a new Identity Mapping Store.
9320
+ # @param [String] parent
9321
+ # Required. The parent collection resource name, such as `projects/`project`/
9322
+ # locations/`location``.
9323
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore] google_cloud_discoveryengine_v1alpha_identity_mapping_store_object
9324
+ # @param [String] cmek_config_name
9325
+ # Resource name of the CmekConfig to use for protecting this Identity Mapping
9326
+ # Store.
9327
+ # @param [Boolean] disable_cmek
9328
+ # Identity Mapping Store without CMEK protections. If a default CmekConfig is
9329
+ # set for the project, setting this field will override the default CmekConfig
9330
+ # as well.
9331
+ # @param [String] identity_mapping_store_id
9332
+ # Required. The ID of the Identity Mapping Store to create. The ID must contain
9333
+ # only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The
9334
+ # maximum length is 63 characters.
9335
+ # @param [String] fields
9336
+ # Selector specifying which fields to include in a partial response.
9337
+ # @param [String] quota_user
9338
+ # Available to use for quota purposes for server-side applications. Can be any
9339
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9340
+ # @param [Google::Apis::RequestOptions] options
9341
+ # Request-specific options
9342
+ #
9343
+ # @yield [result, err] Result & error if block supplied
9344
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore] parsed result object
9345
+ # @yieldparam err [StandardError] error object if request failed
9346
+ #
9347
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore]
9348
+ #
9349
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9350
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9351
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9352
+ 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)
9353
+ command = make_simple_command(:post, 'v1alpha/{+parent}/identityMappingStores', options)
9354
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore::Representation
9355
+ command.request_object = google_cloud_discoveryengine_v1alpha_identity_mapping_store_object
9356
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore::Representation
9357
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore
9358
+ command.params['parent'] = parent unless parent.nil?
9359
+ command.query['cmekConfigName'] = cmek_config_name unless cmek_config_name.nil?
9360
+ command.query['disableCmek'] = disable_cmek unless disable_cmek.nil?
9361
+ command.query['identityMappingStoreId'] = identity_mapping_store_id unless identity_mapping_store_id.nil?
9362
+ command.query['fields'] = fields unless fields.nil?
9363
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9364
+ execute_or_queue_command(command, &block)
9365
+ end
9366
+
9367
+ # Deletes the Identity Mapping Store.
9368
+ # @param [String] name
9369
+ # Required. The name of the Identity Mapping Store to delete. Format: `projects/`
9370
+ # project`/locations/`location`/identityMappingStores/`identityMappingStore``
9371
+ # @param [String] fields
9372
+ # Selector specifying which fields to include in a partial response.
9373
+ # @param [String] quota_user
9374
+ # Available to use for quota purposes for server-side applications. Can be any
9375
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9376
+ # @param [Google::Apis::RequestOptions] options
9377
+ # Request-specific options
9378
+ #
9379
+ # @yield [result, err] Result & error if block supplied
9380
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
9381
+ # @yieldparam err [StandardError] error object if request failed
9382
+ #
9383
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
9384
+ #
9385
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9386
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9387
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9388
+ def delete_project_location_identity_mapping_store(name, fields: nil, quota_user: nil, options: nil, &block)
9389
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
9390
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
9391
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
9392
+ command.params['name'] = name unless name.nil?
9393
+ command.query['fields'] = fields unless fields.nil?
9394
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9395
+ execute_or_queue_command(command, &block)
9396
+ end
9397
+
9398
+ # Gets the Identity Mapping Store.
9399
+ # @param [String] name
9400
+ # Required. The name of the Identity Mapping Store to get. Format: `projects/`
9401
+ # project`/locations/`location`/identityMappingStores/`identityMappingStore``
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::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore] parsed result object
9412
+ # @yieldparam err [StandardError] error object if request failed
9413
+ #
9414
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore]
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 get_project_location_identity_mapping_store(name, fields: nil, quota_user: nil, options: nil, &block)
9420
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
9421
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore::Representation
9422
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityMappingStore
9423
+ command.params['name'] = name unless name.nil?
9424
+ command.query['fields'] = fields unless fields.nil?
9425
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9426
+ execute_or_queue_command(command, &block)
9427
+ end
9428
+
9429
+ # Imports a list of Identity Mapping Entries to an Identity Mapping Store.
9430
+ # @param [String] identity_mapping_store
9431
+ # Required. The name of the Identity Mapping Store to import Identity Mapping
9432
+ # Entries to. Format: `projects/`project`/locations/`location`/
9433
+ # identityMappingStores/`identityMappingStore``
9434
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest] google_cloud_discoveryengine_v1alpha_import_identity_mappings_request_object
9435
+ # @param [String] fields
9436
+ # Selector specifying which fields to include in a partial response.
9437
+ # @param [String] quota_user
9438
+ # Available to use for quota purposes for server-side applications. Can be any
9439
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9440
+ # @param [Google::Apis::RequestOptions] options
9441
+ # Request-specific options
9442
+ #
9443
+ # @yield [result, err] Result & error if block supplied
9444
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
9445
+ # @yieldparam err [StandardError] error object if request failed
9446
+ #
9447
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
9448
+ #
9449
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9450
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9451
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9452
+ 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)
9453
+ command = make_simple_command(:post, 'v1alpha/{+identityMappingStore}:importIdentityMappings', options)
9454
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest::Representation
9455
+ command.request_object = google_cloud_discoveryengine_v1alpha_import_identity_mappings_request_object
9456
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
9457
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
9458
+ command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
9459
+ command.query['fields'] = fields unless fields.nil?
9460
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9461
+ execute_or_queue_command(command, &block)
9462
+ end
9463
+
9464
+ # Lists all Identity Mapping Stores.
9465
+ # @param [String] parent
9466
+ # Required. The parent of the Identity Mapping Stores to list. Format: `projects/
9467
+ # `project`/locations/`location``.
9468
+ # @param [Fixnum] page_size
9469
+ # Maximum number of IdentityMappingStores to return. If unspecified, defaults to
9470
+ # 100. The maximum allowed value is 1000. Values above 1000 will be coerced to
9471
+ # 1000.
9472
+ # @param [String] page_token
9473
+ # A page token, received from a previous `ListIdentityMappingStores` call.
9474
+ # Provide this to retrieve the subsequent page. When paginating, all other
9475
+ # parameters provided to `ListIdentityMappingStores` must match the call that
9476
+ # provided the page token.
9477
+ # @param [String] fields
9478
+ # Selector specifying which fields to include in a partial response.
9479
+ # @param [String] quota_user
9480
+ # Available to use for quota purposes for server-side applications. Can be any
9481
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9482
+ # @param [Google::Apis::RequestOptions] options
9483
+ # Request-specific options
9484
+ #
9485
+ # @yield [result, err] Result & error if block supplied
9486
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse] parsed result object
9487
+ # @yieldparam err [StandardError] error object if request failed
9488
+ #
9489
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse]
9490
+ #
9491
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9492
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9493
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9494
+ def list_project_location_identity_mapping_stores(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
9495
+ command = make_simple_command(:get, 'v1alpha/{+parent}/identityMappingStores', options)
9496
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse::Representation
9497
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse
9498
+ command.params['parent'] = parent unless parent.nil?
9499
+ command.query['pageSize'] = page_size unless page_size.nil?
9500
+ command.query['pageToken'] = page_token unless page_token.nil?
9501
+ command.query['fields'] = fields unless fields.nil?
9502
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9503
+ execute_or_queue_command(command, &block)
9504
+ end
9505
+
9506
+ # Lists Identity Mappings in an Identity Mapping Store.
9507
+ # @param [String] identity_mapping_store
9508
+ # Required. The name of the Identity Mapping Store to list Identity Mapping
9509
+ # Entries in. Format: `projects/`project`/locations/`location`/
9510
+ # identityMappingStores/`identityMappingStore``
9511
+ # @param [Fixnum] page_size
9512
+ # Maximum number of IdentityMappings to return. If unspecified, defaults to 2000.
9513
+ # The maximum allowed value is 10000. Values above 10000 will be coerced to
9514
+ # 10000.
9515
+ # @param [String] page_token
9516
+ # A page token, received from a previous `ListIdentityMappings` call. Provide
9517
+ # this to retrieve the subsequent page. When paginating, all other parameters
9518
+ # provided to `ListIdentityMappings` must match the call that provided the page
9519
+ # token.
9520
+ # @param [String] fields
9521
+ # Selector specifying which fields to include in a partial response.
9522
+ # @param [String] quota_user
9523
+ # Available to use for quota purposes for server-side applications. Can be any
9524
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9525
+ # @param [Google::Apis::RequestOptions] options
9526
+ # Request-specific options
9527
+ #
9528
+ # @yield [result, err] Result & error if block supplied
9529
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse] parsed result object
9530
+ # @yieldparam err [StandardError] error object if request failed
9531
+ #
9532
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse]
9533
+ #
9534
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9535
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9536
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9537
+ 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)
9538
+ command = make_simple_command(:get, 'v1alpha/{+identityMappingStore}:listIdentityMappings', options)
9539
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse::Representation
9540
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse
9541
+ command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
9542
+ command.query['pageSize'] = page_size unless page_size.nil?
9543
+ command.query['pageToken'] = page_token unless page_token.nil?
9544
+ command.query['fields'] = fields unless fields.nil?
9545
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9546
+ execute_or_queue_command(command, &block)
9547
+ end
9548
+
9549
+ # Purges specified or all Identity Mapping Entries from an Identity Mapping
9550
+ # Store.
9551
+ # @param [String] identity_mapping_store
9552
+ # Required. The name of the Identity Mapping Store to purge Identity Mapping
9553
+ # Entries from. Format: `projects/`project`/locations/`location`/
9554
+ # identityMappingStores/`identityMappingStore``
9555
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest] google_cloud_discoveryengine_v1alpha_purge_identity_mappings_request_object
9556
+ # @param [String] fields
9557
+ # Selector specifying which fields to include in a partial response.
9558
+ # @param [String] quota_user
9559
+ # Available to use for quota purposes for server-side applications. Can be any
9560
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9561
+ # @param [Google::Apis::RequestOptions] options
9562
+ # Request-specific options
9563
+ #
9564
+ # @yield [result, err] Result & error if block supplied
9565
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
9566
+ # @yieldparam err [StandardError] error object if request failed
9567
+ #
9568
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
9569
+ #
9570
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9571
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9572
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9573
+ 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)
9574
+ command = make_simple_command(:post, 'v1alpha/{+identityMappingStore}:purgeIdentityMappings', options)
9575
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest::Representation
9576
+ command.request_object = google_cloud_discoveryengine_v1alpha_purge_identity_mappings_request_object
9577
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
9578
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
9579
+ command.params['identityMappingStore'] = identity_mapping_store unless identity_mapping_store.nil?
9580
+ command.query['fields'] = fields unless fields.nil?
9581
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9582
+ execute_or_queue_command(command, &block)
9583
+ end
9584
+
9054
9585
  # Gets the latest state of a long-running operation. Clients can use this method
9055
9586
  # to poll the operation result at intervals as recommended by the API service.
9056
9587
  # @param [String] name
@@ -31,6 +31,9 @@ module Google
31
31
 
32
32
  # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
33
33
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
34
+
35
+ # Search your organization's data in the Cloud Search index
36
+ AUTH_CLOUD_SEARCH_QUERY = 'https://www.googleapis.com/auth/cloud_search.query'
34
37
  end
35
38
  end
36
39
  end