Class TargetSite (0.39.0)

public final class TargetSite extends GeneratedMessageV3 implements TargetSiteOrBuilder

A target site for the SiteSearchEngine.

Protobuf type google.cloud.discoveryengine.v1.TargetSite

Implements

TargetSiteOrBuilder

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()
Returns
Type Description
TargetSite

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TargetSite.Builder newBuilder()
Returns
Type Description
TargetSite.Builder

newBuilder(TargetSite prototype)

public static TargetSite.Builder newBuilder(TargetSite prototype)
Parameter
Name Description
prototype TargetSite
Returns
Type Description
TargetSite.Builder

parseDelimitedFrom(InputStream input)

public static TargetSite parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TargetSite
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TargetSite parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetSite
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TargetSite parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TargetSite
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TargetSite parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetSite
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TargetSite parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TargetSite
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TargetSite parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetSite
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TargetSite parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TargetSite
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TargetSite parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetSite
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TargetSite parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TargetSite
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TargetSite parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetSite
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TargetSite parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TargetSite
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TargetSite parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetSite
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TargetSite> parser()
Returns
Type Description
Parser<TargetSite>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TargetSite getDefaultInstanceForType()
Returns
Type Description
TargetSite

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.v1.TargetSite.FailureReason failure_reason = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TargetSite.FailureReason

The failureReason.

getFailureReasonOrBuilder()

public TargetSite.FailureReasonOrBuilder getFailureReasonOrBuilder()

Output only. Failure reason.

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

Returns
Type Description
TargetSite.FailureReasonOrBuilder

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.v1.TargetSite.IndexingStatus indexing_status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TargetSite.IndexingStatus

The indexingStatus.

getIndexingStatusValue()

public int getIndexingStatusValue()

Output only. Indexing status.

.google.cloud.discoveryengine.v1.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 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 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()
Returns
Type Description
Parser<TargetSite>
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.v1.SiteVerificationInfo site_verification_info = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SiteVerificationInfo

The siteVerificationInfo.

getSiteVerificationInfoOrBuilder()

public SiteVerificationInfoOrBuilder getSiteVerificationInfoOrBuilder()

Output only. Site ownership and validity verification status.

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

Returns
Type Description
SiteVerificationInfoOrBuilder

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.v1.TargetSite.Type type = 3;

Returns
Type Description
TargetSite.Type

The type.

getTypeValue()

public int getTypeValue()

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

.google.cloud.discoveryengine.v1.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];

Returns
Type Description
TimestampOrBuilder

hasFailureReason()

public boolean hasFailureReason()

Output only. Failure reason.

.google.cloud.discoveryengine.v1.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.v1.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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TargetSite.Builder newBuilderForType()
Returns
Type Description
TargetSite.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TargetSite.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TargetSite.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TargetSite.Builder toBuilder()
Returns
Type Description
TargetSite.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException