Interface TargetSiteOrBuilder (0.51.0)

Version latest

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface TargetSiteOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExactMatch()

public abstract boolean getExactMatch()

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.

bool exact_match = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
boolean	The exactMatch.

getFailureReason()

public abstract TargetSite.FailureReason getFailureReason()

Output only. Failure reason.

.google.cloud.discoveryengine.v1beta.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TargetSite.FailureReason	The failureReason.

getFailureReasonOrBuilder()

public abstract TargetSite.FailureReasonOrBuilder getFailureReasonOrBuilder()

Output only. Failure reason.

.google.cloud.discoveryengine.v1beta.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TargetSite.FailureReasonOrBuilder

getGeneratedUriPattern()

public abstract String getGeneratedUriPattern()

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

string generated_uri_pattern = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The generatedUriPattern.

getGeneratedUriPatternBytes()

public abstract ByteString getGeneratedUriPatternBytes()

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

string generated_uri_pattern = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for generatedUriPattern.

getIndexingStatus()

public abstract TargetSite.IndexingStatus getIndexingStatus()

Output only. Indexing status.

.google.cloud.discoveryengine.v1beta.TargetSite.IndexingStatus indexing_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TargetSite.IndexingStatus	The indexingStatus.

getIndexingStatusValue()

public abstract int getIndexingStatusValue()

Output only. Indexing status.

.google.cloud.discoveryengine.v1beta.TargetSite.IndexingStatus indexing_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for indexingStatus.

getName()

public abstract String getName()

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.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for name.

getProvidedUriPattern()

public abstract String getProvidedUriPattern()

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

string provided_uri_pattern = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
String	The providedUriPattern.

getProvidedUriPatternBytes()

public abstract ByteString getProvidedUriPatternBytes()

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

string provided_uri_pattern = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for providedUriPattern.

getRootDomainUri()

public abstract String getRootDomainUri()

Output only. Root domain of the provided_uri_pattern.

string root_domain_uri = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The rootDomainUri.

getRootDomainUriBytes()

public abstract ByteString getRootDomainUriBytes()

Output only. Root domain of the provided_uri_pattern.

string root_domain_uri = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for rootDomainUri.

getSiteVerificationInfo()

public abstract SiteVerificationInfo getSiteVerificationInfo()

Output only. Site ownership and validity verification status.

.google.cloud.discoveryengine.v1beta.SiteVerificationInfo site_verification_info = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SiteVerificationInfo	The siteVerificationInfo.

getSiteVerificationInfoOrBuilder()

public abstract SiteVerificationInfoOrBuilder getSiteVerificationInfoOrBuilder()

Output only. Site ownership and validity verification status.

.google.cloud.discoveryengine.v1beta.SiteVerificationInfo site_verification_info = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SiteVerificationInfoOrBuilder

getType()

public abstract TargetSite.Type getType()

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

.google.cloud.discoveryengine.v1beta.TargetSite.Type type = 3;

Returns
Type	Description
TargetSite.Type	The type.

getTypeValue()

public abstract int getTypeValue()

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

.google.cloud.discoveryengine.v1beta.TargetSite.Type type = 3;

Returns
Type	Description
int	The enum numeric value on the wire for type.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasFailureReason()

public abstract boolean hasFailureReason()

Output only. Failure reason.

.google.cloud.discoveryengine.v1beta.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the failureReason field is set.

hasSiteVerificationInfo()

public abstract boolean hasSiteVerificationInfo()

Output only. Site ownership and validity verification status.

.google.cloud.discoveryengine.v1beta.SiteVerificationInfo site_verification_info = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the siteVerificationInfo field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.