Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Rest::ServiceStub (v1.3.0)

Version 1.3.0

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Rest::ServiceStub.

REST service stub for the SiteSearchEngineService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

• Object

Methods

#batch_create_target_sites

def batch_create_target_sites(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the batch_create_target_sites REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::BatchCreateTargetSitesRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#batch_verify_target_sites

def batch_verify_target_sites(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the batch_verify_target_sites REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::BatchVerifyTargetSitesRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_target_site

def create_target_site(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_target_site REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::CreateTargetSiteRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_target_site

def delete_target_site(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_target_site REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::DeleteTargetSiteRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#disable_advanced_site_search

def disable_advanced_site_search(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the disable_advanced_site_search REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::DisableAdvancedSiteSearchRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#enable_advanced_site_search

def enable_advanced_site_search(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the enable_advanced_site_search REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::EnableAdvancedSiteSearchRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#fetch_domain_verification_status

def fetch_domain_verification_status(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1::FetchDomainVerificationStatusResponse

Baseline implementation for the fetch_domain_verification_status REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::FetchDomainVerificationStatusRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::DiscoveryEngine::V1::FetchDomainVerificationStatusResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::DiscoveryEngine::V1::FetchDomainVerificationStatusResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_site_search_engine

def get_site_search_engine(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine

Baseline implementation for the get_site_search_engine REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::GetSiteSearchEngineRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_target_site

def get_target_site(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1::TargetSite

Baseline implementation for the get_target_site REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::GetTargetSiteRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::DiscoveryEngine::V1::TargetSite)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::DiscoveryEngine::V1::TargetSite) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_target_sites

def list_target_sites(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DiscoveryEngine::V1::ListTargetSitesResponse

Baseline implementation for the list_target_sites REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::ListTargetSitesRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::DiscoveryEngine::V1::ListTargetSitesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::DiscoveryEngine::V1::ListTargetSitesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#recrawl_uris

def recrawl_uris(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the recrawl_uris REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_target_site

def update_target_site(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_target_site REST call

Parameters

• request_pb (::Google::Cloud::DiscoveryEngine::V1::UpdateTargetSiteRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)