Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::TargetSite (v0.8.0)

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

A target site for the SiteSearchEngine.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#exact_match

def exact_match() -> ::Boolean

Returns

(::Boolean) — Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.

#exact_match=

def exact_match=(value) -> ::Boolean

Parameter

value (::Boolean) — Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.

Returns

(::Boolean) — Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.

#failure_reason

def failure_reason() -> ::Google::Cloud::DiscoveryEngine::V1::TargetSite::FailureReason

Returns

(::Google::Cloud::DiscoveryEngine::V1::TargetSite::FailureReason) — Output only. Failure reason.

#generated_uri_pattern

def generated_uri_pattern() -> ::String

Returns

(::String) — Output only. This is system-generated based on the provided_uri_pattern.

#indexing_status

def indexing_status() -> ::Google::Cloud::DiscoveryEngine::V1::TargetSite::IndexingStatus

Returns

(::Google::Cloud::DiscoveryEngine::V1::TargetSite::IndexingStatus) — Output only. Indexing status.

#name

def name() -> ::String

Returns

(::String) — Output only. The fully qualified resource name of the target site. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} The target_site_id is system-generated.

#provided_uri_pattern

def provided_uri_pattern() -> ::String

Returns

(::String) — Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated.

#provided_uri_pattern=

def provided_uri_pattern=(value) -> ::String

Parameter

value (::String) — Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated.

Returns

(::String) — Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated.

#root_domain_uri

def root_domain_uri() -> ::String

Returns

(::String) — Output only. Root domain of the provided_uri_pattern.

#site_verification_info

def site_verification_info() -> ::Google::Cloud::DiscoveryEngine::V1::SiteVerificationInfo

Returns

(::Google::Cloud::DiscoveryEngine::V1::SiteVerificationInfo) — Output only. Site ownership and validity verification status.

#type

def type() -> ::Google::Cloud::DiscoveryEngine::V1::TargetSite::Type

Returns

(::Google::Cloud::DiscoveryEngine::V1::TargetSite::Type) — The type of the target site, e.g., whether the site is to be included or excluded.

#type=

def type=(value) -> ::Google::Cloud::DiscoveryEngine::V1::TargetSite::Type

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::TargetSite::Type) — The type of the target site, e.g., whether the site is to be included or excluded.

Returns

(::Google::Cloud::DiscoveryEngine::V1::TargetSite::Type) — The type of the target site, e.g., whether the site is to be included or excluded.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The target site's last updated time.