Interface TargetSiteOrBuilder (0.31.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
TypeDescription
boolean

The exactMatch.

getFailureReason()

public abstract TargetSite.FailureReason getFailureReason()

Output only. Failure reason.

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

Returns
TypeDescription
TargetSite.FailureReason

The failureReason.

getFailureReasonOrBuilder()

public abstract TargetSite.FailureReasonOrBuilder getFailureReasonOrBuilder()

Output only. Failure reason.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for generatedUriPattern.

getIndexingStatus()

public abstract TargetSite.IndexingStatus getIndexingStatus()

Output only. Indexing status.

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

Returns
TypeDescription
TargetSite.IndexingStatus

The indexingStatus.

getIndexingStatusValue()

public abstract int getIndexingStatusValue()

Output only. Indexing status.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for providedUriPattern.

getSiteVerificationInfo()

public abstract SiteVerificationInfo getSiteVerificationInfo()

Output only. Site ownership and validity verification status.

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

Returns
TypeDescription
SiteVerificationInfo

The siteVerificationInfo.

getSiteVerificationInfoOrBuilder()

public abstract SiteVerificationInfoOrBuilder getSiteVerificationInfoOrBuilder()

Output only. Site ownership and validity verification status.

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

Returns
TypeDescription
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.v1alpha.TargetSite.Type type = 3;

Returns
TypeDescription
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.v1alpha.TargetSite.Type type = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

hasFailureReason()

public abstract boolean hasFailureReason()

Output only. Failure reason.

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

Returns
TypeDescription
boolean

Whether the failureReason field is set.

hasSiteVerificationInfo()

public abstract boolean hasSiteVerificationInfo()

Output only. Site ownership and validity verification status.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.