public final class TargetSite extends com.google.protobuf.GeneratedMessageV3 implements TargetSiteOrBuilder
A target site for the SiteSearchEngine.Protobuf type
google.cloud.discoveryengine.v1beta.TargetSite| Modifier and Type | Class and Description |
|---|---|
static class |
TargetSite.Builder
A target site for the SiteSearchEngine.
|
static class |
TargetSite.FailureReason
Site search indexing failure reasons.
|
static interface |
TargetSite.FailureReasonOrBuilder |
static class |
TargetSite.IndexingStatus
Target site indexing status enumeration.
|
static class |
TargetSite.Type
Possible target site types.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
EXACT_MATCH_FIELD_NUMBER |
static int |
FAILURE_REASON_FIELD_NUMBER |
static int |
GENERATED_URI_PATTERN_FIELD_NUMBER |
static int |
INDEXING_STATUS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PROVIDED_URI_PATTERN_FIELD_NUMBER |
static int |
ROOT_DOMAIN_URI_FIELD_NUMBER |
static int |
SITE_VERIFICATION_INFO_FIELD_NUMBER |
static int |
TYPE_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static TargetSite |
getDefaultInstance() |
TargetSite |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getExactMatch()
Input only.
|
TargetSite.FailureReason |
getFailureReason()
Output only.
|
TargetSite.FailureReasonOrBuilder |
getFailureReasonOrBuilder()
Output only.
|
String |
getGeneratedUriPattern()
Output only.
|
com.google.protobuf.ByteString |
getGeneratedUriPatternBytes()
Output only.
|
TargetSite.IndexingStatus |
getIndexingStatus()
Output only.
|
int |
getIndexingStatusValue()
Output only.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
com.google.protobuf.Parser<TargetSite> |
getParserForType() |
String |
getProvidedUriPattern()
Required.
|
com.google.protobuf.ByteString |
getProvidedUriPatternBytes()
Required.
|
String |
getRootDomainUri()
Output only.
|
com.google.protobuf.ByteString |
getRootDomainUriBytes()
Output only.
|
int |
getSerializedSize() |
SiteVerificationInfo |
getSiteVerificationInfo()
Output only.
|
SiteVerificationInfoOrBuilder |
getSiteVerificationInfoOrBuilder()
Output only.
|
TargetSite.Type |
getType()
The type of the target site, e.g., whether the site is to be included or
excluded.
|
int |
getTypeValue()
The type of the target site, e.g., whether the site is to be included or
excluded.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasFailureReason()
Output only.
|
int |
hashCode() |
boolean |
hasSiteVerificationInfo()
Output only.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static TargetSite.Builder |
newBuilder() |
static TargetSite.Builder |
newBuilder(TargetSite prototype) |
TargetSite.Builder |
newBuilderForType() |
protected TargetSite.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static TargetSite |
parseDelimitedFrom(InputStream input) |
static TargetSite |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TargetSite |
parseFrom(byte[] data) |
static TargetSite |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TargetSite |
parseFrom(ByteBuffer data) |
static TargetSite |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TargetSite |
parseFrom(com.google.protobuf.ByteString data) |
static TargetSite |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TargetSite |
parseFrom(com.google.protobuf.CodedInputStream input) |
static TargetSite |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TargetSite |
parseFrom(InputStream input) |
static TargetSite |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<TargetSite> |
parser() |
TargetSite.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int PROVIDED_URI_PATTERN_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
public static final int EXACT_MATCH_FIELD_NUMBER
public static final int GENERATED_URI_PATTERN_FIELD_NUMBER
public static final int ROOT_DOMAIN_URI_FIELD_NUMBER
public static final int SITE_VERIFICATION_INFO_FIELD_NUMBER
public static final int INDEXING_STATUS_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int FAILURE_REASON_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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];getName in interface TargetSiteOrBuilderpublic com.google.protobuf.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];getNameBytes in interface TargetSiteOrBuilderpublic 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];
getProvidedUriPattern in interface TargetSiteOrBuilderpublic com.google.protobuf.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];
getProvidedUriPatternBytes in interface TargetSiteOrBuilderpublic 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;getTypeValue in interface TargetSiteOrBuilderpublic 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;getType in interface TargetSiteOrBuilderpublic 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];getExactMatch in interface TargetSiteOrBuilderpublic 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];getGeneratedUriPattern in interface TargetSiteOrBuilderpublic com.google.protobuf.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];getGeneratedUriPatternBytes in interface TargetSiteOrBuilderpublic String getRootDomainUri()
Output only. Root domain of the provided_uri_pattern.
string root_domain_uri = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];getRootDomainUri in interface TargetSiteOrBuilderpublic com.google.protobuf.ByteString getRootDomainUriBytes()
Output only. Root domain of the provided_uri_pattern.
string root_domain_uri = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];getRootDomainUriBytes in interface TargetSiteOrBuilderpublic 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];
hasSiteVerificationInfo in interface TargetSiteOrBuilderpublic 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];
getSiteVerificationInfo in interface TargetSiteOrBuilderpublic 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];
getSiteVerificationInfoOrBuilder in interface TargetSiteOrBuilderpublic int getIndexingStatusValue()
Output only. Indexing status.
.google.cloud.discoveryengine.v1beta.TargetSite.IndexingStatus indexing_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getIndexingStatusValue in interface TargetSiteOrBuilderpublic TargetSite.IndexingStatus getIndexingStatus()
Output only. Indexing status.
.google.cloud.discoveryengine.v1beta.TargetSite.IndexingStatus indexing_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getIndexingStatus in interface TargetSiteOrBuilderpublic boolean hasUpdateTime()
Output only. The target site's last updated time.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface TargetSiteOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. The target site's last updated time.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface TargetSiteOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The target site's last updated time.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface TargetSiteOrBuilderpublic boolean hasFailureReason()
Output only. Failure reason.
.google.cloud.discoveryengine.v1beta.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasFailureReason in interface TargetSiteOrBuilderpublic TargetSite.FailureReason getFailureReason()
Output only. Failure reason.
.google.cloud.discoveryengine.v1beta.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getFailureReason in interface TargetSiteOrBuilderpublic TargetSite.FailureReasonOrBuilder getFailureReasonOrBuilder()
Output only. Failure reason.
.google.cloud.discoveryengine.v1beta.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getFailureReasonOrBuilder in interface TargetSiteOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static TargetSite parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TargetSite parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TargetSite parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TargetSite parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TargetSite parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TargetSite parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TargetSite parseFrom(InputStream input) throws IOException
IOExceptionpublic static TargetSite parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static TargetSite parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static TargetSite parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static TargetSite parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static TargetSite parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic TargetSite.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static TargetSite.Builder newBuilder()
public static TargetSite.Builder newBuilder(TargetSite prototype)
public TargetSite.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected TargetSite.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static TargetSite getDefaultInstance()
public static com.google.protobuf.Parser<TargetSite> parser()
public com.google.protobuf.Parser<TargetSite> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public TargetSite getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.