Class SearchResponse.SearchResult.Builder (0.83.0)

0.83.0 (latest) 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

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

Represents the search results.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult

Inheritance

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

Implements

SearchResponse.SearchResultOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

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

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

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.v1beta.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.v1beta.Document document = 2;

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

clearRankSignals()

public SearchResponse.SearchResult.Builder clearRankSignals()

A set of ranking signals associated with the result.

.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchResponse.SearchResult.Builder

containsModelScores(String key)

public boolean containsModelScores(String key)

Google provided available scores.

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

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

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getDocument()

public Document getDocument()

The document data snippet in the search response. Only fields that are marked as retrievable are populated.

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

Google provided available scores.

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

Returns
Type	Description
int

getModelScoresMap()

public Map<String,DoubleList> getModelScoresMap()

Google provided available scores.

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

Returns
Type	Description
Map<String,DoubleList>

getModelScoresOrDefault(String key, DoubleList defaultValue)

public DoubleList getModelScoresOrDefault(String key, DoubleList defaultValue)

Google provided available scores.

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

Parameters
Name	Description
key	String
defaultValue	DoubleList

Returns
Type	Description
DoubleList

getModelScoresOrThrow(String key)

public DoubleList getModelScoresOrThrow(String key)

Google provided available scores.

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the rankSignals field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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.v1beta.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	SearchResponse.SearchResult.RankSignals

Returns
Type	Description
SearchResponse.SearchResult.Builder

putAllModelScores(Map<String,DoubleList> values)

public SearchResponse.SearchResult.Builder putAllModelScores(Map<String,DoubleList> values)

Google provided available scores.

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

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)

Google provided available scores.

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

Parameters
Name	Description
key	String
value	DoubleList

Returns
Type	Description
SearchResponse.SearchResult.Builder

putModelScoresBuilderIfAbsent(String key)

public DoubleList.Builder putModelScoresBuilderIfAbsent(String key)

Google provided available scores.

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
DoubleList.Builder

removeModelScores(String key)

public SearchResponse.SearchResult.Builder removeModelScores(String key)

Google provided available scores.

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

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.v1beta.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.v1beta.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.v1beta.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.v1beta.Document document = 2;

Parameter
Name	Description
builderForValue	Document.Builder

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	String The 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	ByteString The 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.v1beta.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.v1beta.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