Class TargetSite.Builder (0.38.0) 

public static final class TargetSite.Builder extends GeneratedMessageV3.Builder<TargetSite.Builder> implements TargetSiteOrBuilder

A target site for the SiteSearchEngine.

Protobuf type google.cloud.discoveryengine.v1.TargetSite

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TargetSite.Builder

Implements

TargetSiteOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TargetSite.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TargetSite.Builder
Overrides

build()

public TargetSite build()
Returns
Type Description
TargetSite

buildPartial()

public TargetSite buildPartial()
Returns
Type Description
TargetSite

clear()

public TargetSite.Builder clear()
Returns
Type Description
TargetSite.Builder
Overrides

clearExactMatch()

public TargetSite.Builder clearExactMatch()

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
TargetSite.Builder

This builder for chaining.

clearFailureReason()

public TargetSite.Builder clearFailureReason()

Output only. Failure reason.

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

Returns
Type Description
TargetSite.Builder

clearField(Descriptors.FieldDescriptor field)

public TargetSite.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TargetSite.Builder
Overrides

clearGeneratedUriPattern()

public TargetSite.Builder clearGeneratedUriPattern()

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
TargetSite.Builder

This builder for chaining.

clearIndexingStatus()

public TargetSite.Builder clearIndexingStatus()

Output only. Indexing status.

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

Returns
Type Description
TargetSite.Builder

This builder for chaining.

clearName()

public TargetSite.Builder clearName()

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
TargetSite.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TargetSite.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TargetSite.Builder
Overrides

clearProvidedUriPattern()

public TargetSite.Builder clearProvidedUriPattern()

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
TargetSite.Builder

This builder for chaining.

clearSiteVerificationInfo()

public TargetSite.Builder clearSiteVerificationInfo()

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
TargetSite.Builder

clearType()

public TargetSite.Builder clearType()

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.Builder

This builder for chaining.

clearUpdateTime()

public TargetSite.Builder clearUpdateTime()

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

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

Returns
Type Description
TargetSite.Builder

clone()

public TargetSite.Builder clone()
Returns
Type Description
TargetSite.Builder
Overrides

getDefaultInstanceForType()

public TargetSite getDefaultInstanceForType()
Returns
Type Description
TargetSite

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getFailureReasonBuilder()

public TargetSite.FailureReason.Builder getFailureReasonBuilder()

Output only. Failure reason.

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

Returns
Type Description
TargetSite.FailureReason.Builder

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.

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.

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.

getSiteVerificationInfoBuilder()

public SiteVerificationInfo.Builder getSiteVerificationInfoBuilder()

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.Builder

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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

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

Returns
Type Description
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFailureReason(TargetSite.FailureReason value)

public TargetSite.Builder mergeFailureReason(TargetSite.FailureReason value)

Output only. Failure reason.

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

Parameter
Name Description
value TargetSite.FailureReason
Returns
Type Description
TargetSite.Builder

mergeFrom(TargetSite other)

public TargetSite.Builder mergeFrom(TargetSite other)
Parameter
Name Description
other TargetSite
Returns
Type Description
TargetSite.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TargetSite.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetSite.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TargetSite.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TargetSite.Builder
Overrides

mergeSiteVerificationInfo(SiteVerificationInfo value)

public TargetSite.Builder mergeSiteVerificationInfo(SiteVerificationInfo value)

Output only. Site ownership and validity verification status.

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

Parameter
Name Description
value SiteVerificationInfo
Returns
Type Description
TargetSite.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TargetSite.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TargetSite.Builder
Overrides

mergeUpdateTime(Timestamp value)

public TargetSite.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TargetSite.Builder

setExactMatch(boolean value)

public TargetSite.Builder setExactMatch(boolean value)

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];

Parameter
Name Description
value boolean

The exactMatch to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setFailureReason(TargetSite.FailureReason value)

public TargetSite.Builder setFailureReason(TargetSite.FailureReason value)

Output only. Failure reason.

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

Parameter
Name Description
value TargetSite.FailureReason
Returns
Type Description
TargetSite.Builder

setFailureReason(TargetSite.FailureReason.Builder builderForValue)

public TargetSite.Builder setFailureReason(TargetSite.FailureReason.Builder builderForValue)

Output only. Failure reason.

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

Parameter
Name Description
builderForValue TargetSite.FailureReason.Builder
Returns
Type Description
TargetSite.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TargetSite.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TargetSite.Builder
Overrides

setGeneratedUriPattern(String value)

public TargetSite.Builder setGeneratedUriPattern(String value)

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

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

Parameter
Name Description
value String

The generatedUriPattern to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setGeneratedUriPatternBytes(ByteString value)

public TargetSite.Builder setGeneratedUriPatternBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for generatedUriPattern to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setIndexingStatus(TargetSite.IndexingStatus value)

public TargetSite.Builder setIndexingStatus(TargetSite.IndexingStatus value)

Output only. Indexing status.

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

Parameter
Name Description
value TargetSite.IndexingStatus

The indexingStatus to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setIndexingStatusValue(int value)

public TargetSite.Builder setIndexingStatusValue(int value)

Output only. Indexing status.

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

Parameter
Name Description
value int

The enum numeric value on the wire for indexingStatus to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setName(String value)

public TargetSite.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TargetSite.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setProvidedUriPattern(String value)

public TargetSite.Builder setProvidedUriPattern(String value)

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];

Parameter
Name Description
value String

The providedUriPattern to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setProvidedUriPatternBytes(ByteString value)

public TargetSite.Builder setProvidedUriPatternBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for providedUriPattern to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TargetSite.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TargetSite.Builder
Overrides

setSiteVerificationInfo(SiteVerificationInfo value)

public TargetSite.Builder setSiteVerificationInfo(SiteVerificationInfo value)

Output only. Site ownership and validity verification status.

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

Parameter
Name Description
value SiteVerificationInfo
Returns
Type Description
TargetSite.Builder

setSiteVerificationInfo(SiteVerificationInfo.Builder builderForValue)

public TargetSite.Builder setSiteVerificationInfo(SiteVerificationInfo.Builder builderForValue)

Output only. Site ownership and validity verification status.

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

Parameter
Name Description
builderForValue SiteVerificationInfo.Builder
Returns
Type Description
TargetSite.Builder

setType(TargetSite.Type value)

public TargetSite.Builder setType(TargetSite.Type value)

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;

Parameter
Name Description
value TargetSite.Type

The type to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setTypeValue(int value)

public TargetSite.Builder setTypeValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.
Returns
Type Description
TargetSite.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TargetSite.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TargetSite.Builder
Overrides

setUpdateTime(Timestamp value)

public TargetSite.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
TargetSite.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public TargetSite.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TargetSite.Builder