Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1TargetSite

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

A target site for the SiteSearchEngine.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1TargetSite

Returns a new instance of GoogleCloudDiscoveryengineV1TargetSite.



2333
2334
2335
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2333

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#exact_match ⇒ Boolean Also known as: exact_match?

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. Corresponds to the JSON property exactMatch

Returns:

  • (Boolean) 


2280
2281
2282
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2280

def exact_match
  @exact_match
end

#failure_reason ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1TargetSiteFailureReason

Site search indexing failure reasons. Corresponds to the JSON property failureReason

Returns:



2286
2287
2288
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2286

def failure_reason
  @failure_reason
end

#generated_uri_pattern ⇒ String

Output only. This is system-generated based on the provided_uri_pattern. Corresponds to the JSON property generatedUriPattern

Returns:

  • (String) 


2291
2292
2293
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2291

def generated_uri_pattern
  @generated_uri_pattern
end

#indexing_status ⇒ String

Output only. Indexing status. Corresponds to the JSON property indexingStatus

Returns:

  • (String) 


2296
2297
2298
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2296

def indexing_status
  @indexing_status
end

#name ⇒ 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`Thetarget_site_idis system- generated. Corresponds to the JSON propertyname`

Returns:

  • (String) 


2304
2305
2306
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2304

def name
  @name
end

#provided_uri_pattern ⇒ String

Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated. Corresponds to the JSON property providedUriPattern

Returns:

  • (String) 


2310
2311
2312
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2310

def provided_uri_pattern
  @provided_uri_pattern
end

#root_domain_uri ⇒ String

Output only. Root domain of the provided_uri_pattern. Corresponds to the JSON property rootDomainUri

Returns:

  • (String) 


2315
2316
2317
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2315

def root_domain_uri
  @root_domain_uri
end

#site_verification_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1SiteVerificationInfo

Verification information for target sites in advanced site search. Corresponds to the JSON property siteVerificationInfo

Returns:



2320
2321
2322
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2320

def site_verification_info
  @site_verification_info
end

#type ⇒ String

The type of the target site, e.g., whether the site is to be included or excluded. Corresponds to the JSON property type

Returns:

  • (String) 


2326
2327
2328
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2326

def type
  @type
end

#update_time ⇒ String

Output only. The target site's last updated time. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2331
2332
2333
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2331

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2338

def update!(**args)
  @exact_match = args[:exact_match] if args.key?(:exact_match)
  @failure_reason = args[:failure_reason] if args.key?(:failure_reason)
  @generated_uri_pattern = args[:generated_uri_pattern] if args.key?(:generated_uri_pattern)
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
  @name = args[:name] if args.key?(:name)
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
  @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
  @type = args[:type] if args.key?(:type)
  @update_time = args[:update_time] if args.key?(:update_time)
end