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.



4588
4589
4590
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4588

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

Instance Attribute Details

#exact_matchBoolean 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)


4540
4541
4542
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4540

def exact_match
  @exact_match
end

#failure_reasonGoogle::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason

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



4546
4547
4548
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4546

def failure_reason
  @failure_reason
end

#generated_uri_patternString

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

Returns:

  • (String)


4551
4552
4553
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4551

def generated_uri_pattern
  @generated_uri_pattern
end

#indexing_statusString

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

Returns:

  • (String)


4556
4557
4558
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4556

def indexing_status
  @indexing_status
end

#nameString

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)


4564
4565
4566
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4564

def name
  @name
end

#provided_uri_patternString

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

Returns:

  • (String)


4570
4571
4572
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4570

def provided_uri_pattern
  @provided_uri_pattern
end

#site_verification_infoGoogle::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo

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



4575
4576
4577
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4575

def site_verification_info
  @site_verification_info
end

#typeString

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)


4581
4582
4583
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4581

def type
  @type
end

#update_timeString

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

Returns:

  • (String)


4586
4587
4588
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4586

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4593

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