- 0.59.0 (latest)
- 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.Builder extends GeneratedMessageV3.Builder<SearchResponse.Builder> implements SearchResponseOrBuilderResponse message for SearchService.Search method.
Protobuf type google.cloud.discoveryengine.v1.SearchResponse
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.BuilderImplements
SearchResponseOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllResults(Iterable<? extends SearchResponse.SearchResult> values)
public SearchResponse.Builder addAllResults(Iterable<? extends SearchResponse.SearchResult> values)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.SearchResponse.SearchResult> |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addResults(SearchResponse.SearchResult value)
public SearchResponse.Builder addResults(SearchResponse.SearchResult value)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.SearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addResults(SearchResponse.SearchResult.Builder builderForValue)
public SearchResponse.Builder addResults(SearchResponse.SearchResult.Builder builderForValue)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.SearchResult.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addResults(int index, SearchResponse.SearchResult value)
public SearchResponse.Builder addResults(int index, SearchResponse.SearchResult value)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchResponse.SearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addResults(int index, SearchResponse.SearchResult.Builder builderForValue)
public SearchResponse.Builder addResults(int index, SearchResponse.SearchResult.Builder builderForValue)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.SearchResult.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addResultsBuilder()
public SearchResponse.SearchResult.Builder addResultsBuilder()A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
addResultsBuilder(int index)
public SearchResponse.SearchResult.Builder addResultsBuilder(int index)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
build()
public SearchResponse build()| Returns | |
|---|---|
| Type | Description |
SearchResponse |
|
buildPartial()
public SearchResponse buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchResponse |
|
clear()
public SearchResponse.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
clearAttributionToken()
public SearchResponse.Builder clearAttributionToken()A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
string attribution_token = 4;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
clearCorrectedQuery()
public SearchResponse.Builder clearCorrectedQuery()Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.
string corrected_query = 7;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SearchResponse.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
clearNextPageToken()
public SearchResponse.Builder clearNextPageToken()A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
clearResults()
public SearchResponse.Builder clearResults()A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
clearTotalSize()
public SearchResponse.Builder clearTotalSize()The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
int32 total_size = 3;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
clone()
public SearchResponse.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
getAttributionToken()
public String getAttributionToken()A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
string attribution_token = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The attributionToken. |
getAttributionTokenBytes()
public ByteString getAttributionTokenBytes()A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
string attribution_token = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for attributionToken. |
getCorrectedQuery()
public String getCorrectedQuery()Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.
string corrected_query = 7;
| Returns | |
|---|---|
| Type | Description |
String |
The correctedQuery. |
getCorrectedQueryBytes()
public ByteString getCorrectedQueryBytes()Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.
string corrected_query = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for correctedQuery. |
getDefaultInstanceForType()
public SearchResponse getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchResponse |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getNextPageToken()
public String getNextPageToken()A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The nextPageToken. |
getNextPageTokenBytes()
public ByteString getNextPageTokenBytes()A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for nextPageToken. |
getResults(int index)
public SearchResponse.SearchResult getResults(int index)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult |
|
getResultsBuilder(int index)
public SearchResponse.SearchResult.Builder getResultsBuilder(int index)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
getResultsBuilderList()
public List<SearchResponse.SearchResult.Builder> getResultsBuilderList()A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getResultsCount()
public int getResultsCount()A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
int |
|
getResultsList()
public List<SearchResponse.SearchResult> getResultsList()A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
List<SearchResult> |
|
getResultsOrBuilder(int index)
public SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResultOrBuilder |
|
getResultsOrBuilderList()
public List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.SearchResponse.SearchResultOrBuilder> |
|
getTotalSize()
public int getTotalSize()The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
int32 total_size = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The totalSize. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchResponse other)
public SearchResponse.Builder mergeFrom(SearchResponse other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchResponse |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchResponse.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
removeResults(int index)
public SearchResponse.Builder removeResults(int index)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setAttributionToken(String value)
public SearchResponse.Builder setAttributionToken(String value)A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
string attribution_token = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe attributionToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setAttributionTokenBytes(ByteString value)
public SearchResponse.Builder setAttributionTokenBytes(ByteString value)A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
string attribution_token = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for attributionToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setCorrectedQuery(String value)
public SearchResponse.Builder setCorrectedQuery(String value)Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.
string corrected_query = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe correctedQuery to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setCorrectedQueryBytes(ByteString value)
public SearchResponse.Builder setCorrectedQueryBytes(ByteString value)Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.
string corrected_query = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for correctedQuery to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setNextPageToken(String value)
public SearchResponse.Builder setNextPageToken(String value)A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe nextPageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setNextPageTokenBytes(ByteString value)
public SearchResponse.Builder setNextPageTokenBytes(ByteString value)A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for nextPageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setResults(int index, SearchResponse.SearchResult value)
public SearchResponse.Builder setResults(int index, SearchResponse.SearchResult value)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchResponse.SearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setResults(int index, SearchResponse.SearchResult.Builder builderForValue)
public SearchResponse.Builder setResults(int index, SearchResponse.SearchResult.Builder builderForValue)A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.SearchResult.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setTotalSize(int value)
public SearchResponse.Builder setTotalSize(int value)The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
int32 total_size = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe totalSize to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|