REST Resource: projects.locations.dataStores.siteSearchEngine.targetSites

Resource: TargetSite

A target site for the SiteSearchEngine.

JSON representation
{
  "name": string,
  "providedUriPattern": string,
  "type": enum (Type),
  "exactMatch": boolean,
  "generatedUriPattern": string,
  "rootDomainUri": string,
  "siteVerificationInfo": {
    object (SiteVerificationInfo)
  },
  "indexingStatus": enum (IndexingStatus),
  "updateTime": string,
  "failureReason": {
    object (FailureReason)
  }
}
Fields
name

string

Output only. The fully qualified resource name of the target site. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} The target_site_id is system-generated.

providedUriPattern

string

Required. Input only. The user provided URI pattern from which the generatedUriPattern is generated.

type

enum (Type)

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

exactMatch

boolean

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

generatedUriPattern

string

Output only. This is system-generated based on the providedUriPattern.

rootDomainUri

string

Output only. Root domain of the providedUriPattern.

siteVerificationInfo

object (SiteVerificationInfo)

Output only. Site ownership and validity verification status.

indexingStatus

enum (IndexingStatus)

Output only. Indexing status.

updateTime

string (Timestamp format)

Output only. The target site's last updated time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

failureReason

object (FailureReason)

Output only. Failure reason.

Methods

batchCreate

Creates TargetSite in a batch.

create

Creates a TargetSite.

delete

Deletes a TargetSite.

get

Gets a TargetSite.

list

Gets a list of TargetSites.

patch

Updates a TargetSite.