Resource: TargetSite
A target site for the SiteSearchEngine.
JSON representation |
---|
{ "name": string, "providedUriPattern": string, "type": enum ( |
Fields | |
---|---|
name |
Output only. The fully qualified resource name of the target site. |
provided |
Required. Input only. The user provided URI pattern from which the |
type |
The type of the target site, e.g., whether the site is to be included or excluded. |
exact |
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. |
generated |
Output only. This is system-generated based on the providedUriPattern. |
root |
Output only. Root domain of the providedUriPattern. |
site |
Output only. Site ownership and validity verification status. |
indexing |
Output only. Indexing status. |
update |
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: |
failure |
Output only. Failure reason. |
Type
Possible target site types.
Enums | |
---|---|
TYPE_UNSPECIFIED |
This value is unused. In this case, server behavior defaults to Type.INCLUDE . |
INCLUDE |
Include the target site. |
EXCLUDE |
Exclude the target site. |
SiteVerificationInfo
Verification information for target sites in advanced site search.
JSON representation |
---|
{
"siteVerificationState": enum ( |
Fields | |
---|---|
site |
Site verification state indicating the ownership and validity. |
verify |
Latest site verification time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
SiteVerificationState
Site verification state.
Enums | |
---|---|
SITE_VERIFICATION_STATE_UNSPECIFIED |
Defaults to VERIFIED. |
VERIFIED |
Site ownership verified. |
UNVERIFIED |
Site ownership pending verification or verification failed. |
EXEMPTED |
Site exempt from verification, e.g., a public website that opens to all. |
IndexingStatus
Target site indexing status enumeration.
Enums | |
---|---|
INDEXING_STATUS_UNSPECIFIED |
Defaults to SUCCEEDED. |
PENDING |
The target site is in the update queue and will be picked up by indexing pipeline. |
FAILED |
The target site fails to be indexed. |
SUCCEEDED |
The target site has been indexed. |
DELETING |
The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails. |
FailureReason
Site search indexing failure reasons.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field failure . Failure reason. failure can be only one of the following: |
|
quota |
Failed due to insufficient quota. |
QuotaFailure
Failed due to insufficient quota.
JSON representation |
---|
{ "totalRequiredQuota": string } |
Fields | |
---|---|
total |
This number is an estimation on how much total quota this project needs to successfully complete indexing. |
Methods |
|
---|---|
|
Creates TargetSite in a batch. |
|
Creates a TargetSite . |
|
Deletes a TargetSite . |
|
Gets a TargetSite . |
|
Gets a list of TargetSite s. |
|
Updates a TargetSite . |