TargetSite(mapping=None, *, ignore_unknown_fields=False, **kwargs)A target site for the SiteSearchEngine.
Attributes | |
|---|---|
| Name | Description |
name |
str
Output only. The fully qualified resource name of the target site. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}
The target_site_id is system-generated.
|
provided_uri_pattern |
str
Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated.
|
type_ |
google.cloud.discoveryengine_v1.types.TargetSite.Type
The type of the target site, e.g., whether the site is to be included or excluded. |
exact_match |
bool
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. |
generated_uri_pattern |
str
Output only. This is system-generated based on the provided_uri_pattern. |
site_verification_info |
google.cloud.discoveryengine_v1.types.SiteVerificationInfo
Output only. Site ownership and validity verification status. |
indexing_status |
google.cloud.discoveryengine_v1.types.TargetSite.IndexingStatus
Output only. Indexing status. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The target site's last updated time. |
failure_reason |
google.cloud.discoveryengine_v1.types.TargetSite.FailureReason
Output only. Failure reason. |
Classes
FailureReason
FailureReason(mapping=None, *, ignore_unknown_fields=False, **kwargs)Site search indexing failure reasons.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
IndexingStatus
IndexingStatus(value)Target site indexing status enumeration.
Values: INDEXING_STATUS_UNSPECIFIED (0): Defaults to SUCCEEDED. PENDING (1): The target site is in the update queue and will be picked up by indexing pipeline. FAILED (2): The target site fails to be indexed. SUCCEEDED (3): The target site has been indexed. DELETING (4): 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.
Type
Type(value)Possible target site types.
Values: TYPE_UNSPECIFIED (0): This value is unused. In this case, server behavior defaults to Type.INCLUDE. INCLUDE (1): Include the target site. EXCLUDE (2): Exclude the target site.