public static final class SearchResponse.SearchResult.Builder extends GeneratedMessageV3.Builder<SearchResponse.SearchResult.Builder> implements SearchResponse.SearchResultOrBuilderRepresents the search results.
Protobuf type google.cloud.discoveryengine.v1.SearchResponse.SearchResult
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.SearchResult.BuilderImplements
SearchResponse.SearchResultOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.SearchResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
build()
public SearchResponse.SearchResult build()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult |
|
buildPartial()
public SearchResponse.SearchResult buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult |
|
clear()
public SearchResponse.SearchResult.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
clearChunk()
public SearchResponse.SearchResult.Builder clearChunk()The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
.google.cloud.discoveryengine.v1.Chunk chunk = 18;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
clearDocument()
public SearchResponse.SearchResult.Builder clearDocument() The document data snippet in the search response. Only fields that are
marked as retrievable are populated.
.google.cloud.discoveryengine.v1.Document document = 2;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public SearchResponse.SearchResult.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
clearId()
public SearchResponse.SearchResult.Builder clearId()Document.id of the searched Document.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
This builder for chaining. |
clearModelScores()
public SearchResponse.SearchResult.Builder clearModelScores()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchResponse.SearchResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
clearRankSignals()
public SearchResponse.SearchResult.Builder clearRankSignals()A set of ranking signals associated with the result.
.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
clone()
public SearchResponse.SearchResult.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
containsModelScores(String key)
public boolean containsModelScores(String key)Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getChunk()
public Chunk getChunk()The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
.google.cloud.discoveryengine.v1.Chunk chunk = 18;
| Returns | |
|---|---|
| Type | Description |
Chunk |
The chunk. |
getChunkBuilder()
public Chunk.Builder getChunkBuilder()The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
.google.cloud.discoveryengine.v1.Chunk chunk = 18;
| Returns | |
|---|---|
| Type | Description |
Chunk.Builder |
|
getChunkOrBuilder()
public ChunkOrBuilder getChunkOrBuilder()The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
.google.cloud.discoveryengine.v1.Chunk chunk = 18;
| Returns | |
|---|---|
| Type | Description |
ChunkOrBuilder |
|
getDefaultInstanceForType()
public SearchResponse.SearchResult getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDocument()
public Document getDocument() The document data snippet in the search response. Only fields that are
marked as retrievable are populated.
.google.cloud.discoveryengine.v1.Document document = 2;
| Returns | |
|---|---|
| Type | Description |
Document |
The document. |
getDocumentBuilder()
public Document.Builder getDocumentBuilder() The document data snippet in the search response. Only fields that are
marked as retrievable are populated.
.google.cloud.discoveryengine.v1.Document document = 2;
| Returns | |
|---|---|
| Type | Description |
Document.Builder |
|
getDocumentOrBuilder()
public DocumentOrBuilder getDocumentOrBuilder() The document data snippet in the search response. Only fields that are
marked as retrievable are populated.
.google.cloud.discoveryengine.v1.Document document = 2;
| Returns | |
|---|---|
| Type | Description |
DocumentOrBuilder |
|
getId()
public String getId()Document.id of the searched Document.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The id. |
getIdBytes()
public ByteString getIdBytes()Document.id of the searched Document.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for id. |
getModelScores() (deprecated)
public Map<String,DoubleList> getModelScores()Use #getModelScoresMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,DoubleList> |
|
getModelScoresCount()
public int getModelScoresCount()Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getModelScoresMap()
public Map<String,DoubleList> getModelScoresMap()Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Map<String,DoubleList> |
|
getModelScoresOrDefault(String key, DoubleList defaultValue)
public DoubleList getModelScoresOrDefault(String key, DoubleList defaultValue)Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
DoubleList |
| Returns | |
|---|---|
| Type | Description |
DoubleList |
|
getModelScoresOrThrow(String key)
public DoubleList getModelScoresOrThrow(String key)Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
DoubleList |
|
getMutableModelScores() (deprecated)
public Map<String,DoubleList> getMutableModelScores()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,DoubleList> |
|
getRankSignals()
public SearchResponse.SearchResult.RankSignals getRankSignals()A set of ranking signals associated with the result.
.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.RankSignals |
The rankSignals. |
getRankSignalsBuilder()
public SearchResponse.SearchResult.RankSignals.Builder getRankSignalsBuilder()A set of ranking signals associated with the result.
.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.RankSignals.Builder |
|
getRankSignalsOrBuilder()
public SearchResponse.SearchResult.RankSignalsOrBuilder getRankSignalsOrBuilder()A set of ranking signals associated with the result.
.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.RankSignalsOrBuilder |
|
hasChunk()
public boolean hasChunk()The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
.google.cloud.discoveryengine.v1.Chunk chunk = 18;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the chunk field is set. |
hasDocument()
public boolean hasDocument() The document data snippet in the search response. Only fields that are
marked as retrievable are populated.
.google.cloud.discoveryengine.v1.Document document = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the document field is set. |
hasRankSignals()
public boolean hasRankSignals()A set of ranking signals associated with the result.
.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rankSignals field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeChunk(Chunk value)
public SearchResponse.SearchResult.Builder mergeChunk(Chunk value)The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
.google.cloud.discoveryengine.v1.Chunk chunk = 18;
| Parameter | |
|---|---|
| Name | Description |
value |
Chunk |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
mergeDocument(Document value)
public SearchResponse.SearchResult.Builder mergeDocument(Document value) The document data snippet in the search response. Only fields that are
marked as retrievable are populated.
.google.cloud.discoveryengine.v1.Document document = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Document |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
mergeFrom(SearchResponse.SearchResult other)
public SearchResponse.SearchResult.Builder mergeFrom(SearchResponse.SearchResult other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchResponse.SearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchResponse.SearchResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchResponse.SearchResult.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
mergeRankSignals(SearchResponse.SearchResult.RankSignals value)
public SearchResponse.SearchResult.Builder mergeRankSignals(SearchResponse.SearchResult.RankSignals value)A set of ranking signals associated with the result.
.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.SearchResult.RankSignals |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.SearchResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
putAllModelScores(Map<String,DoubleList> values)
public SearchResponse.SearchResult.Builder putAllModelScores(Map<String,DoubleList> values)Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,DoubleList> |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
putModelScores(String key, DoubleList value)
public SearchResponse.SearchResult.Builder putModelScores(String key, DoubleList value)Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
DoubleList |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
putModelScoresBuilderIfAbsent(String key)
public DoubleList.Builder putModelScoresBuilderIfAbsent(String key)Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
DoubleList.Builder |
|
removeModelScores(String key)
public SearchResponse.SearchResult.Builder removeModelScores(String key)Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
setChunk(Chunk value)
public SearchResponse.SearchResult.Builder setChunk(Chunk value)The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
.google.cloud.discoveryengine.v1.Chunk chunk = 18;
| Parameter | |
|---|---|
| Name | Description |
value |
Chunk |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
setChunk(Chunk.Builder builderForValue)
public SearchResponse.SearchResult.Builder setChunk(Chunk.Builder builderForValue)The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
.google.cloud.discoveryengine.v1.Chunk chunk = 18;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Chunk.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
setDocument(Document value)
public SearchResponse.SearchResult.Builder setDocument(Document value) The document data snippet in the search response. Only fields that are
marked as retrievable are populated.
.google.cloud.discoveryengine.v1.Document document = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Document |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
setDocument(Document.Builder builderForValue)
public SearchResponse.SearchResult.Builder setDocument(Document.Builder builderForValue) The document data snippet in the search response. Only fields that are
marked as retrievable are populated.
.google.cloud.discoveryengine.v1.Document document = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Document.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.SearchResult.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
setId(String value)
public SearchResponse.SearchResult.Builder setId(String value)Document.id of the searched Document.
string id = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe id to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
This builder for chaining. |
setIdBytes(ByteString value)
public SearchResponse.SearchResult.Builder setIdBytes(ByteString value)Document.id of the searched Document.
string id = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for id to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
This builder for chaining. |
setRankSignals(SearchResponse.SearchResult.RankSignals value)
public SearchResponse.SearchResult.Builder setRankSignals(SearchResponse.SearchResult.RankSignals value)A set of ranking signals associated with the result.
.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.SearchResult.RankSignals |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
setRankSignals(SearchResponse.SearchResult.RankSignals.Builder builderForValue)
public SearchResponse.SearchResult.Builder setRankSignals(SearchResponse.SearchResult.RankSignals.Builder builderForValue)A set of ranking signals associated with the result.
.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.SearchResult.RankSignals.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchResponse.SearchResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.SearchResult.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|