Class SearchResponse (0.31.0)

public final class SearchResponse extends GeneratedMessageV3 implements SearchResponseOrBuilder

Response message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse

Static Fields

APPLIED_CONTROLS_FIELD_NUMBER

public static final int APPLIED_CONTROLS_FIELD_NUMBER
Field Value
TypeDescription
int

ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

CORRECTED_QUERY_FIELD_NUMBER

public static final int CORRECTED_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

FACETS_FIELD_NUMBER

public static final int FACETS_FIELD_NUMBER
Field Value
TypeDescription
int

GUIDED_SEARCH_RESULT_FIELD_NUMBER

public static final int GUIDED_SEARCH_RESULT_FIELD_NUMBER
Field Value
TypeDescription
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_EXPANSION_INFO_FIELD_NUMBER

public static final int QUERY_EXPANSION_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

REDIRECT_URI_FIELD_NUMBER

public static final int REDIRECT_URI_FIELD_NUMBER
Field Value
TypeDescription
int

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER
Field Value
TypeDescription
int

SUMMARY_FIELD_NUMBER

public static final int SUMMARY_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_SIZE_FIELD_NUMBER

public static final int TOTAL_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchResponse getDefaultInstance()
Returns
TypeDescription
SearchResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchResponse.Builder newBuilder()
Returns
TypeDescription
SearchResponse.Builder

newBuilder(SearchResponse prototype)

public static SearchResponse.Builder newBuilder(SearchResponse prototype)
Parameter
NameDescription
prototypeSearchResponse
Returns
TypeDescription
SearchResponse.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchResponse> parser()
Returns
TypeDescription
Parser<SearchResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAppliedControls(int index)

public String getAppliedControls(int index)

Controls applied as part of the Control service.

repeated string applied_controls = 10;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The appliedControls at the given index.

getAppliedControlsBytes(int index)

public ByteString getAppliedControlsBytes(int index)

Controls applied as part of the Control service.

repeated string applied_controls = 10;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the appliedControls at the given index.

getAppliedControlsCount()

public int getAppliedControlsCount()

Controls applied as part of the Control service.

repeated string applied_controls = 10;

Returns
TypeDescription
int

The count of appliedControls.

getAppliedControlsList()

public ProtocolStringList getAppliedControlsList()

Controls applied as part of the Control service.

repeated string applied_controls = 10;

Returns
TypeDescription
ProtocolStringList

A list containing the appliedControls.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for correctedQuery.

getDefaultInstanceForType()

public SearchResponse getDefaultInstanceForType()
Returns
TypeDescription
SearchResponse

getFacets(int index)

public SearchResponse.Facet getFacets(int index)

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Facet

getFacetsCount()

public int getFacetsCount()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;

Returns
TypeDescription
int

getFacetsList()

public List<SearchResponse.Facet> getFacetsList()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;

Returns
TypeDescription
List<Facet>

getFacetsOrBuilder(int index)

public SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.FacetOrBuilder

getFacetsOrBuilderList()

public List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;

Returns
TypeDescription
List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.FacetOrBuilder>

getGuidedSearchResult()

public SearchResponse.GuidedSearchResult getGuidedSearchResult()

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Returns
TypeDescription
SearchResponse.GuidedSearchResult

The guidedSearchResult.

getGuidedSearchResultOrBuilder()

public SearchResponse.GuidedSearchResultOrBuilder getGuidedSearchResultOrBuilder()

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Returns
TypeDescription
SearchResponse.GuidedSearchResultOrBuilder

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
TypeDescription
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
TypeDescription
ByteString

The bytes for nextPageToken.

getParserForType()

public Parser<SearchResponse> getParserForType()
Returns
TypeDescription
Parser<SearchResponse>
Overrides

getQueryExpansionInfo()

public SearchResponse.QueryExpansionInfo getQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
TypeDescription
SearchResponse.QueryExpansionInfo

The queryExpansionInfo.

getQueryExpansionInfoOrBuilder()

public SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
TypeDescription
SearchResponse.QueryExpansionInfoOrBuilder

getRedirectUri()

public String getRedirectUri()

The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.

string redirect_uri = 12;

Returns
TypeDescription
String

The redirectUri.

getRedirectUriBytes()

public ByteString getRedirectUriBytes()

The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.

string redirect_uri = 12;

Returns
TypeDescription
ByteString

The bytes for redirectUri.

getResults(int index)

public SearchResponse.SearchResult getResults(int index)

A list of matched documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.SearchResult

getResultsCount()

public int getResultsCount()

A list of matched documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Returns
TypeDescription
int

getResultsList()

public List<SearchResponse.SearchResult> getResultsList()

A list of matched documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Returns
TypeDescription
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.v1beta.SearchResponse.SearchResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.SearchResultOrBuilder

getResultsOrBuilderList()

public List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()

A list of matched documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Returns
TypeDescription
List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResultOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSummary()

public SearchResponse.Summary getSummary()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

Returns
TypeDescription
SearchResponse.Summary

The summary.

getSummaryOrBuilder()

public SearchResponse.SummaryOrBuilder getSummaryOrBuilder()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

Returns
TypeDescription
SearchResponse.SummaryOrBuilder

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
TypeDescription
int

The totalSize.

hasGuidedSearchResult()

public boolean hasGuidedSearchResult()

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Returns
TypeDescription
boolean

Whether the guidedSearchResult field is set.

hasQueryExpansionInfo()

public boolean hasQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
TypeDescription
boolean

Whether the queryExpansionInfo field is set.

hasSummary()

public boolean hasSummary()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

Returns
TypeDescription
boolean

Whether the summary field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchResponse.Builder newBuilderForType()
Returns
TypeDescription
SearchResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchResponse.Builder toBuilder()
Returns
TypeDescription
SearchResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException