public final class TargetSite extends GeneratedMessageV3 implements TargetSiteOrBuilder
A target site for the SiteSearchEngine.
Protobuf type google.cloud.discoveryengine.v1alpha.TargetSite
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
EXACT_MATCH_FIELD_NUMBER
public static final int EXACT_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FAILURE_REASON_FIELD_NUMBER
public static final int FAILURE_REASON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GENERATED_URI_PATTERN_FIELD_NUMBER
public static final int GENERATED_URI_PATTERN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INDEXING_STATUS_FIELD_NUMBER
public static final int INDEXING_STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROVIDED_URI_PATTERN_FIELD_NUMBER
public static final int PROVIDED_URI_PATTERN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SITE_VERIFICATION_INFO_FIELD_NUMBER
public static final int SITE_VERIFICATION_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static TargetSite getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TargetSite.Builder newBuilder()
newBuilder(TargetSite prototype)
public static TargetSite.Builder newBuilder(TargetSite prototype)
public static TargetSite parseDelimitedFrom(InputStream input)
public static TargetSite parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TargetSite parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TargetSite parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TargetSite parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TargetSite parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TargetSite parseFrom(CodedInputStream input)
public static TargetSite parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TargetSite parseFrom(InputStream input)
public static TargetSite parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TargetSite parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TargetSite parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TargetSite> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public TargetSite getDefaultInstanceForType()
getExactMatch()
public 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 TargetSite.FailureReason getFailureReason()
Output only. Failure reason.
.google.cloud.discoveryengine.v1alpha.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getFailureReasonOrBuilder()
public TargetSite.FailureReasonOrBuilder getFailureReasonOrBuilder()
Output only. Failure reason.
.google.cloud.discoveryengine.v1alpha.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getGeneratedUriPattern()
public 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 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 TargetSite.IndexingStatus getIndexingStatus()
Output only. Indexing status.
.google.cloud.discoveryengine.v1alpha.TargetSite.IndexingStatus indexing_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getIndexingStatusValue()
public int getIndexingStatusValue()
Output only. Indexing status.
.google.cloud.discoveryengine.v1alpha.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()
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 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.
|
getParserForType()
public Parser<TargetSite> getParserForType()
Overrides
getProvidedUriPattern()
public 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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSiteVerificationInfo()
public 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];
getSiteVerificationInfoOrBuilder()
public 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];
getType()
public 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;
getTypeValue()
public 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 |
| Type |
Description |
int |
The enum numeric value on the wire for type.
|
getUpdateTime()
public 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 TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The target site's last updated time.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasFailureReason()
public boolean hasFailureReason()
Output only. Failure reason.
.google.cloud.discoveryengine.v1alpha.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the failureReason field is set.
|
hasSiteVerificationInfo()
public 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 |
| Type |
Description |
boolean |
Whether the siteVerificationInfo field is set.
|
hasUpdateTime()
public 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TargetSite.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TargetSite.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public TargetSite.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
