Class SearchResponse.SearchResult.RetrievalSignals.Builder (0.95.0) 

public static final class SearchResponse.SearchResult.RetrievalSignals.Builder extends GeneratedMessage.Builder<SearchResponse.SearchResult.RetrievalSignals.Builder> implements SearchResponse.SearchResult.RetrievalSignalsOrBuilder

Contains a set of signals used by the relevance filter.

Protobuf type google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchResponse.SearchResult.RetrievalSignals.Builder

Static Methods

getDescriptor()

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

Methods

addAllRetrievalSources(Iterable<? extends SearchResponse.SearchResult.RetrievalSignals.RetrievalSource> values)

public SearchResponse.SearchResult.RetrievalSignals.Builder addAllRetrievalSources(Iterable<? extends SearchResponse.SearchResult.RetrievalSignals.RetrievalSource> values)

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource>

The retrievalSources to add.
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

This builder for chaining.

addAllRetrievalSourcesValue(Iterable<Integer> values)

public SearchResponse.SearchResult.RetrievalSignals.Builder addAllRetrievalSourcesValue(Iterable<Integer> values)

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for retrievalSources to add.
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

This builder for chaining.

addRetrievalSources(SearchResponse.SearchResult.RetrievalSignals.RetrievalSource value)

public SearchResponse.SearchResult.RetrievalSignals.Builder addRetrievalSources(SearchResponse.SearchResult.RetrievalSignals.RetrievalSource value)

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SearchResponse.SearchResult.RetrievalSignals.RetrievalSource

The retrievalSources to add.
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

This builder for chaining.

addRetrievalSourcesValue(int value)

public SearchResponse.SearchResult.RetrievalSignals.Builder addRetrievalSourcesValue(int value)

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for retrievalSources to add.
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

This builder for chaining.

build()

public SearchResponse.SearchResult.RetrievalSignals build()
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals

buildPartial()

public SearchResponse.SearchResult.RetrievalSignals buildPartial()
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals

clear()

public SearchResponse.SearchResult.RetrievalSignals.Builder clear()
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder
Overrides

clearRetrievalSources()

public SearchResponse.SearchResult.RetrievalSignals.Builder clearRetrievalSources()

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

This builder for chaining.

clearSemanticRelevanceScore()

public SearchResponse.SearchResult.RetrievalSignals.Builder clearSemanticRelevanceScore()

Optional. Relevance score used by the filter when semantic_relevance_threshold is set.

float semantic_relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

This builder for chaining.

getDefaultInstanceForType()

public SearchResponse.SearchResult.RetrievalSignals getDefaultInstanceForType()
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals

getDescriptorForType()

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

getRetrievalSources(int index)

public SearchResponse.SearchResult.RetrievalSignals.RetrievalSource getRetrievalSources(int index)

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.RetrievalSource

The retrievalSources at the given index.

getRetrievalSourcesCount()

public int getRetrievalSourcesCount()

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of retrievalSources.

getRetrievalSourcesList()

public List<SearchResponse.SearchResult.RetrievalSignals.RetrievalSource> getRetrievalSourcesList()

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<RetrievalSource>

A list containing the retrievalSources.

getRetrievalSourcesValue(int index)

public int getRetrievalSourcesValue(int index)

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of retrievalSources at the given index.

getRetrievalSourcesValueList()

public List<Integer> getRetrievalSourcesValueList()

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for retrievalSources.

getSemanticRelevanceScore()

public float getSemanticRelevanceScore()

Optional. Relevance score used by the filter when semantic_relevance_threshold is set.

float semantic_relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The semanticRelevanceScore.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchResponse.SearchResult.RetrievalSignals other)

public SearchResponse.SearchResult.RetrievalSignals.Builder mergeFrom(SearchResponse.SearchResult.RetrievalSignals other)
Parameter
Name Description
other SearchResponse.SearchResult.RetrievalSignals
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public SearchResponse.SearchResult.RetrievalSignals.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder
Overrides

setRetrievalSources(int index, SearchResponse.SearchResult.RetrievalSignals.RetrievalSource value)

public SearchResponse.SearchResult.RetrievalSignals.Builder setRetrievalSources(int index, SearchResponse.SearchResult.RetrievalSignals.RetrievalSource value)

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value SearchResponse.SearchResult.RetrievalSignals.RetrievalSource

The retrievalSources to set.
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

This builder for chaining.

setRetrievalSourcesValue(int index, int value)

public SearchResponse.SearchResult.RetrievalSignals.Builder setRetrievalSourcesValue(int index, int value)

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for retrievalSources to set.
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

This builder for chaining.

setSemanticRelevanceScore(float value)

public SearchResponse.SearchResult.RetrievalSignals.Builder setSemanticRelevanceScore(float value)

Optional. Relevance score used by the filter when semantic_relevance_threshold is set.

float semantic_relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value float

The semanticRelevanceScore to set.
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

This builder for chaining.