Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite

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) ⇒ GoogleCloudDiscoveryengineV1alphaTargetSite

Returns a new instance of GoogleCloudDiscoveryengineV1alphaTargetSite.



6939
6940
6941
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6939

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) 


6891
6892
6893
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6891

def exact_match
  @exact_match
end

#failure_reason ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason

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

Returns:



6897
6898
6899
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6897

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) 


6902
6903
6904
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6902

def generated_uri_pattern
  @generated_uri_pattern
end

#indexing_status ⇒ String

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

Returns:

  • (String) 


6907
6908
6909
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6907

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) 


6915
6916
6917
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6915

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) 


6921
6922
6923
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6921

def provided_uri_pattern
  @provided_uri_pattern
end

#site_verification_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo

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

Returns:



6926
6927
6928
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6926

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) 


6932
6933
6934
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6932

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


6937
6938
6939
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6937

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6944

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)
  @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