Class: Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb
Overview
Client for the SiteSearchEngineService service.
Service for managing site search related resources.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#location_client ⇒ Google::Cloud::Location::Locations::Client
readonly
Get the associated client for mix-in of the Locations.
-
#operations_client ⇒ ::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the SiteSearchEngineService Client class.
Instance Method Summary collapse
-
#batch_create_target_sites(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates TargetSite in a batch.
-
#batch_verify_target_sites(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Verify target sites' ownership and validity.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the SiteSearchEngineService Client instance.
-
#create_target_site(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a TargetSite.
-
#delete_target_site(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a TargetSite.
-
#disable_advanced_site_search(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Downgrade from advanced site search to basic site search.
-
#enable_advanced_site_search(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Upgrade from basic site search to advanced site search.
-
#fetch_domain_verification_status(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::TargetSite>
Returns list of target sites with its domain verification status.
-
#get_site_search_engine(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine
Gets the SiteSearchEngine.
-
#get_target_site(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::DiscoveryEngine::V1::TargetSite
Gets a TargetSite.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new SiteSearchEngineService client object.
-
#list_target_sites(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::TargetSite>
Gets a list of TargetSites.
-
#recrawl_uris(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Request on-demand recrawl for a list of URIs.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_target_site(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates a TargetSite.
Methods included from Paths
#site_search_engine_path, #target_site_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new SiteSearchEngineService client object.
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 122 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/discoveryengine/v1/site_search_engine_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @site_search_engine_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @site_search_engine_service_stub.endpoint config.universe_domain = @site_search_engine_service_stub.universe_domain end end |
Instance Attribute Details
#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)
Get the associated client for mix-in of the Locations.
188 189 190 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 188 def location_client @location_client end |
#operations_client ⇒ ::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Operations (readonly)
Get the associated client for long-running operations.
181 182 183 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 181 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the SiteSearchEngineService Client class.
See Configuration for a description of the configuration fields.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 60 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "DiscoveryEngine", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config end yield @configure if block_given? @configure end |
Instance Method Details
#batch_create_target_sites(request, options = nil) ⇒ ::Gapic::Operation #batch_create_target_sites(parent: nil, requests: nil) ⇒ ::Gapic::Operation
Creates TargetSite in a batch.
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 441 def batch_create_target_sites request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::BatchCreateTargetSitesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.batch_create_target_sites..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.batch_create_target_sites.timeout, metadata: , retry_policy: @config.rpcs.batch_create_target_sites.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :batch_create_target_sites, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#batch_verify_target_sites(request, options = nil) ⇒ ::Gapic::Operation #batch_verify_target_sites(parent: nil) ⇒ ::Gapic::Operation
Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1232 def batch_verify_target_sites request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::BatchVerifyTargetSitesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.batch_verify_target_sites..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.batch_verify_target_sites.timeout, metadata: , retry_policy: @config.rpcs.batch_verify_target_sites.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :batch_verify_target_sites, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#configure {|config| ... } ⇒ Client::Configuration
Configure the SiteSearchEngineService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
92 93 94 95 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 92 def configure yield @config if block_given? @config end |
#create_target_site(request, options = nil) ⇒ ::Gapic::Operation #create_target_site(parent: nil, target_site: nil) ⇒ ::Gapic::Operation
Creates a TargetSite.
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 341 def create_target_site request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::CreateTargetSiteRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_target_site..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_target_site.timeout, metadata: , retry_policy: @config.rpcs.create_target_site.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :create_target_site, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_target_site(request, options = nil) ⇒ ::Gapic::Operation #delete_target_site(name: nil) ⇒ ::Gapic::Operation
Deletes a TargetSite.
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 736 def delete_target_site request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::DeleteTargetSiteRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_target_site..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_target_site.timeout, metadata: , retry_policy: @config.rpcs.delete_target_site.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :delete_target_site, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#disable_advanced_site_search(request, options = nil) ⇒ ::Gapic::Operation #disable_advanced_site_search(site_search_engine: nil) ⇒ ::Gapic::Operation
Downgrade from advanced site search to basic site search.
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1036 def disable_advanced_site_search request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::DisableAdvancedSiteSearchRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.disable_advanced_site_search..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.site_search_engine header_params["site_search_engine"] = request.site_search_engine end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.disable_advanced_site_search.timeout, metadata: , retry_policy: @config.rpcs.disable_advanced_site_search.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :disable_advanced_site_search, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#enable_advanced_site_search(request, options = nil) ⇒ ::Gapic::Operation #enable_advanced_site_search(site_search_engine: nil) ⇒ ::Gapic::Operation
Upgrade from basic site search to advanced site search.
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 940 def enable_advanced_site_search request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::EnableAdvancedSiteSearchRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.enable_advanced_site_search..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.site_search_engine header_params["site_search_engine"] = request.site_search_engine end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.enable_advanced_site_search.timeout, metadata: , retry_policy: @config.rpcs.enable_advanced_site_search.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :enable_advanced_site_search, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#fetch_domain_verification_status(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::TargetSite> #fetch_domain_verification_status(site_search_engine: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::TargetSite>
Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1339 def fetch_domain_verification_status request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::FetchDomainVerificationStatusRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.fetch_domain_verification_status..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.site_search_engine header_params["site_search_engine"] = request.site_search_engine end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.fetch_domain_verification_status.timeout, metadata: , retry_policy: @config.rpcs.fetch_domain_verification_status.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :fetch_domain_verification_status, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @site_search_engine_service_stub, :fetch_domain_verification_status, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_site_search_engine(request, options = nil) ⇒ ::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine #get_site_search_engine(name: nil) ⇒ ::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine
Gets the SiteSearchEngine.
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 244 def get_site_search_engine request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::GetSiteSearchEngineRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_site_search_engine..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_site_search_engine.timeout, metadata: , retry_policy: @config.rpcs.get_site_search_engine.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :get_site_search_engine, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_target_site(request, options = nil) ⇒ ::Google::Cloud::DiscoveryEngine::V1::TargetSite #get_target_site(name: nil) ⇒ ::Google::Cloud::DiscoveryEngine::V1::TargetSite
Gets a TargetSite.
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 536 def get_target_site request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::GetTargetSiteRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_target_site..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_target_site.timeout, metadata: , retry_policy: @config.rpcs.get_target_site.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :get_target_site, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_target_sites(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::TargetSite> #list_target_sites(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::TargetSite>
Gets a list of TargetSites.
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 844 def list_target_sites request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::ListTargetSitesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_target_sites..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_target_sites.timeout, metadata: , retry_policy: @config.rpcs.list_target_sites.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :list_target_sites, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @site_search_engine_service_stub, :list_target_sites, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#recrawl_uris(request, options = nil) ⇒ ::Gapic::Operation #recrawl_uris(site_search_engine: nil, uris: nil) ⇒ ::Gapic::Operation
Request on-demand recrawl for a list of URIs.
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1136 def recrawl_uris request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.recrawl_uris..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.site_search_engine header_params["site_search_engine"] = request.site_search_engine end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.recrawl_uris.timeout, metadata: , retry_policy: @config.rpcs.recrawl_uris.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :recrawl_uris, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
102 103 104 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 102 def universe_domain @site_search_engine_service_stub.universe_domain end |
#update_target_site(request, options = nil) ⇒ ::Gapic::Operation #update_target_site(target_site: nil) ⇒ ::Gapic::Operation
Updates a TargetSite.
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 |
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 634 def update_target_site request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::UpdateTargetSiteRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_target_site..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.target_site&.name header_params["target_site.name"] = request.target_site.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_target_site.timeout, metadata: , retry_policy: @config.rpcs.update_target_site.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @site_search_engine_service_stub.call_rpc :update_target_site, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |