Class SearchResponse.SearchResult.RankSignals.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>
com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.Builder
- All Implemented Interfaces:
SearchResponse.SearchResult.RankSignalsOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- SearchResponse.SearchResult.RankSignals
public static final class SearchResponse.SearchResult.RankSignals.Builder
extends com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>
implements SearchResponse.SearchResult.RankSignalsOrBuilder
A set of ranking signals.Protobuf type
google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals-
Method Summary
Modifier and TypeMethodDescriptionaddAllCustomSignals(Iterable<? extends SearchResponse.SearchResult.RankSignals.CustomSignal> values) A list of custom clearbox signals.addCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal value) A list of custom clearbox signals.addCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue) A list of custom clearbox signals.A list of custom clearbox signals.A list of custom clearbox signals.A list of custom clearbox signals.addCustomSignalsBuilder(int index) A list of custom clearbox signals.build()clear()Combined custom boosts for a doc.A list of custom clearbox signals.The default rank of the result.Age of the document in hours.Keyword matching adjustment.Predicted conversion rate adjustment as a rank.Semantic relevance adjustment.Semantic similarity adjustment.Topicality adjustment as a rank.floatCombined custom boosts for a doc.getCustomSignals(int index) A list of custom clearbox signals.getCustomSignalsBuilder(int index) A list of custom clearbox signals.A list of custom clearbox signals.intA list of custom clearbox signals.A list of custom clearbox signals.getCustomSignalsOrBuilder(int index) A list of custom clearbox signals.A list of custom clearbox signals.floatThe default rank of the result.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorfloatAge of the document in hours.floatKeyword matching adjustment.floatPredicted conversion rate adjustment as a rank.floatSemantic relevance adjustment.floatSemantic similarity adjustment.floatTopicality adjustment as a rank.booleanCombined custom boosts for a doc.booleanAge of the document in hours.booleanKeyword matching adjustment.booleanPredicted conversion rate adjustment as a rank.booleanSemantic relevance adjustment.booleanSemantic similarity adjustment.booleanTopicality adjustment as a rank.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) removeCustomSignals(int index) A list of custom clearbox signals.setBoostingFactor(float value) Combined custom boosts for a doc.setCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal value) A list of custom clearbox signals.setCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue) A list of custom clearbox signals.setDefaultRank(float value) The default rank of the result.setDocumentAge(float value) Age of the document in hours.setKeywordSimilarityScore(float value) Keyword matching adjustment.setPctrRank(float value) Predicted conversion rate adjustment as a rank.setRelevanceScore(float value) Semantic relevance adjustment.setSemanticSimilarityScore(float value) Semantic similarity adjustment.setTopicalityRank(float value) Topicality adjustment as a rank.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>
-
mergeFrom
public SearchResponse.SearchResult.RankSignals.Builder mergeFrom(SearchResponse.SearchResult.RankSignals other) -
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>
-
mergeFrom
public SearchResponse.SearchResult.RankSignals.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>- Throws:
IOException
-
hasKeywordSimilarityScore
public boolean hasKeywordSimilarityScore()Keyword matching adjustment.
optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasKeywordSimilarityScorein interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- Whether the keywordSimilarityScore field is set.
-
getKeywordSimilarityScore
public float getKeywordSimilarityScore()Keyword matching adjustment.
optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getKeywordSimilarityScorein interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- The keywordSimilarityScore.
-
setKeywordSimilarityScore
Keyword matching adjustment.
optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The keywordSimilarityScore to set.- Returns:
- This builder for chaining.
-
clearKeywordSimilarityScore
Keyword matching adjustment.
optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
hasRelevanceScore
public boolean hasRelevanceScore()Semantic relevance adjustment.
optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasRelevanceScorein interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- Whether the relevanceScore field is set.
-
getRelevanceScore
public float getRelevanceScore()Semantic relevance adjustment.
optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getRelevanceScorein interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- The relevanceScore.
-
setRelevanceScore
Semantic relevance adjustment.
optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The relevanceScore to set.- Returns:
- This builder for chaining.
-
clearRelevanceScore
Semantic relevance adjustment.
optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
hasSemanticSimilarityScore
public boolean hasSemanticSimilarityScore()Semantic similarity adjustment.
optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasSemanticSimilarityScorein interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- Whether the semanticSimilarityScore field is set.
-
getSemanticSimilarityScore
public float getSemanticSimilarityScore()Semantic similarity adjustment.
optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getSemanticSimilarityScorein interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- The semanticSimilarityScore.
-
setSemanticSimilarityScore
Semantic similarity adjustment.
optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The semanticSimilarityScore to set.- Returns:
- This builder for chaining.
-
clearSemanticSimilarityScore
Semantic similarity adjustment.
optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
hasPctrRank
public boolean hasPctrRank()Predicted conversion rate adjustment as a rank.
optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasPctrRankin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- Whether the pctrRank field is set.
-
getPctrRank
public float getPctrRank()Predicted conversion rate adjustment as a rank.
optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPctrRankin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- The pctrRank.
-
setPctrRank
Predicted conversion rate adjustment as a rank.
optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The pctrRank to set.- Returns:
- This builder for chaining.
-
clearPctrRank
Predicted conversion rate adjustment as a rank.
optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
hasTopicalityRank
public boolean hasTopicalityRank()Topicality adjustment as a rank.
optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasTopicalityRankin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- Whether the topicalityRank field is set.
-
getTopicalityRank
public float getTopicalityRank()Topicality adjustment as a rank.
optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getTopicalityRankin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- The topicalityRank.
-
setTopicalityRank
Topicality adjustment as a rank.
optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The topicalityRank to set.- Returns:
- This builder for chaining.
-
clearTopicalityRank
Topicality adjustment as a rank.
optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
hasDocumentAge
public boolean hasDocumentAge()Age of the document in hours.
optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasDocumentAgein interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- Whether the documentAge field is set.
-
getDocumentAge
public float getDocumentAge()Age of the document in hours.
optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDocumentAgein interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- The documentAge.
-
setDocumentAge
Age of the document in hours.
optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The documentAge to set.- Returns:
- This builder for chaining.
-
clearDocumentAge
Age of the document in hours.
optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
hasBoostingFactor
public boolean hasBoostingFactor()Combined custom boosts for a doc.
optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasBoostingFactorin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- Whether the boostingFactor field is set.
-
getBoostingFactor
public float getBoostingFactor()Combined custom boosts for a doc.
optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getBoostingFactorin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- The boostingFactor.
-
setBoostingFactor
Combined custom boosts for a doc.
optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The boostingFactor to set.- Returns:
- This builder for chaining.
-
clearBoostingFactor
Combined custom boosts for a doc.
optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
getDefaultRank
public float getDefaultRank()The default rank of the result.
float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDefaultRankin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder- Returns:
- The defaultRank.
-
setDefaultRank
The default rank of the result.
float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The defaultRank to set.- Returns:
- This builder for chaining.
-
clearDefaultRank
The default rank of the result.
float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
getCustomSignalsList
A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getCustomSignalsListin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder
-
getCustomSignalsCount
public int getCustomSignalsCount()A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getCustomSignalsCountin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder
-
getCustomSignals
A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getCustomSignalsin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder
-
setCustomSignals
public SearchResponse.SearchResult.RankSignals.Builder setCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal value) A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
setCustomSignals
public SearchResponse.SearchResult.RankSignals.Builder setCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue) A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
addCustomSignals
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(SearchResponse.SearchResult.RankSignals.CustomSignal value) A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
addCustomSignals
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal value) A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
addCustomSignals
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue) A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
addCustomSignals
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue) A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
addAllCustomSignals
public SearchResponse.SearchResult.RankSignals.Builder addAllCustomSignals(Iterable<? extends SearchResponse.SearchResult.RankSignals.CustomSignal> values) A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
clearCustomSignals
A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
removeCustomSignals
A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
getCustomSignalsBuilder
public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder getCustomSignalsBuilder(int index) A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
getCustomSignalsOrBuilder
public SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder getCustomSignalsOrBuilder(int index) A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getCustomSignalsOrBuilderin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder
-
getCustomSignalsOrBuilderList
public List<? extends SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder> getCustomSignalsOrBuilderList()A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getCustomSignalsOrBuilderListin interfaceSearchResponse.SearchResult.RankSignalsOrBuilder
-
addCustomSignalsBuilder
A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
addCustomSignalsBuilder
public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder addCustomSignalsBuilder(int index) A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL]; -
getCustomSignalsBuilderList
public List<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder> getCustomSignalsBuilderList()A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
-