Class CompleteQueryResponse (2.47.0) 

public final class CompleteQueryResponse extends GeneratedMessageV3 implements CompleteQueryResponseOrBuilder

Response of the autocomplete query.

Protobuf type google.cloud.retail.v2alpha.CompleteQueryResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CompleteQueryResponse

Static Fields

ATTRIBUTE_RESULTS_FIELD_NUMBER

public static final int ATTRIBUTE_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

COMPLETION_RESULTS_FIELD_NUMBER

public static final int COMPLETION_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

RECENT_SEARCH_RESULTS_FIELD_NUMBER

public static final int RECENT_SEARCH_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CompleteQueryResponse getDefaultInstance()
Returns
Type Description
CompleteQueryResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CompleteQueryResponse.Builder newBuilder()
Returns
Type Description
CompleteQueryResponse.Builder

newBuilder(CompleteQueryResponse prototype)

public static CompleteQueryResponse.Builder newBuilder(CompleteQueryResponse prototype)
Parameter
Name Description
prototype CompleteQueryResponse
Returns
Type Description
CompleteQueryResponse.Builder

parseDelimitedFrom(InputStream input)

public static CompleteQueryResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CompleteQueryResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CompleteQueryResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CompleteQueryResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CompleteQueryResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CompleteQueryResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CompleteQueryResponse> parser()
Returns
Type Description
Parser<CompleteQueryResponse>

Methods

containsAttributeResults(String key)

public boolean containsAttributeResults(String key)

A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset.

Current supported keys:

  • brands

  • categories

map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAttributeResults() (deprecated)

public Map<String,CompleteQueryResponse.AttributeResult> getAttributeResults()

Use #getAttributeResultsMap() instead.

Returns
Type Description
Map<String,AttributeResult>

getAttributeResultsCount()

public int getAttributeResultsCount()

A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset.

Current supported keys:

  • brands

  • categories

map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;

Returns
Type Description
int

getAttributeResultsMap()

public Map<String,CompleteQueryResponse.AttributeResult> getAttributeResultsMap()

A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset.

Current supported keys:

  • brands

  • categories

map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;

Returns
Type Description
Map<String,AttributeResult>

getAttributeResultsOrDefault(String key, CompleteQueryResponse.AttributeResult defaultValue)

public CompleteQueryResponse.AttributeResult getAttributeResultsOrDefault(String key, CompleteQueryResponse.AttributeResult defaultValue)

A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset.

Current supported keys:

  • brands

  • categories

map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;

Parameters
Name Description
key String
defaultValue CompleteQueryResponse.AttributeResult
Returns
Type Description
CompleteQueryResponse.AttributeResult

getAttributeResultsOrThrow(String key)

public CompleteQueryResponse.AttributeResult getAttributeResultsOrThrow(String key)

A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset.

Current supported keys:

  • brands

  • categories

map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;

Parameter
Name Description
key String
Returns
Type Description
CompleteQueryResponse.AttributeResult

getAttributionToken()

public String getAttributionToken()

A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.

string attribution_token = 2;

Returns
Type Description
String

The attributionToken.

getAttributionTokenBytes()

public ByteString getAttributionTokenBytes()

A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.

string attribution_token = 2;

Returns
Type Description
ByteString

The bytes for attributionToken.

getCompletionResults(int index)

public CompleteQueryResponse.CompletionResult getCompletionResults(int index)

Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

repeated .google.cloud.retail.v2alpha.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
Name Description
index int
Returns
Type Description
CompleteQueryResponse.CompletionResult

getCompletionResultsCount()

public int getCompletionResultsCount()

Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

repeated .google.cloud.retail.v2alpha.CompleteQueryResponse.CompletionResult completion_results = 1;

Returns
Type Description
int

getCompletionResultsList()

public List<CompleteQueryResponse.CompletionResult> getCompletionResultsList()

Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

repeated .google.cloud.retail.v2alpha.CompleteQueryResponse.CompletionResult completion_results = 1;

Returns
Type Description
List<CompletionResult>

getCompletionResultsOrBuilder(int index)

public CompleteQueryResponse.CompletionResultOrBuilder getCompletionResultsOrBuilder(int index)

Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

repeated .google.cloud.retail.v2alpha.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
Name Description
index int
Returns
Type Description
CompleteQueryResponse.CompletionResultOrBuilder

getCompletionResultsOrBuilderList()

public List<? extends CompleteQueryResponse.CompletionResultOrBuilder> getCompletionResultsOrBuilderList()

Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

repeated .google.cloud.retail.v2alpha.CompleteQueryResponse.CompletionResult completion_results = 1;

Returns
Type Description
List<? extends com.google.cloud.retail.v2alpha.CompleteQueryResponse.CompletionResultOrBuilder>

getDefaultInstanceForType()

public CompleteQueryResponse getDefaultInstanceForType()
Returns
Type Description
CompleteQueryResponse

getParserForType()

public Parser<CompleteQueryResponse> getParserForType()
Returns
Type Description
Parser<CompleteQueryResponse>
Overrides

getRecentSearchResults(int index)

public CompleteQueryResponse.RecentSearchResult getRecentSearchResults(int index)

Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it.

This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules:

  • They are ordered from latest to oldest.

  • They are matched with CompleteQueryRequest.query case insensitively.

  • They are transformed to lower case.

  • They are UTF-8 safe.

    Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

repeated .google.cloud.retail.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;

Parameter
Name Description
index int
Returns
Type Description
CompleteQueryResponse.RecentSearchResult

getRecentSearchResultsCount()

public int getRecentSearchResultsCount()

Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it.

This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules:

  • They are ordered from latest to oldest.

  • They are matched with CompleteQueryRequest.query case insensitively.

  • They are transformed to lower case.

  • They are UTF-8 safe.

    Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

repeated .google.cloud.retail.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;

Returns
Type Description
int

getRecentSearchResultsList()

public List<CompleteQueryResponse.RecentSearchResult> getRecentSearchResultsList()

Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it.

This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules:

  • They are ordered from latest to oldest.

  • They are matched with CompleteQueryRequest.query case insensitively.

  • They are transformed to lower case.

  • They are UTF-8 safe.

    Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

repeated .google.cloud.retail.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;

Returns
Type Description
List<RecentSearchResult>

getRecentSearchResultsOrBuilder(int index)

public CompleteQueryResponse.RecentSearchResultOrBuilder getRecentSearchResultsOrBuilder(int index)

Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it.

This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules:

  • They are ordered from latest to oldest.

  • They are matched with CompleteQueryRequest.query case insensitively.

  • They are transformed to lower case.

  • They are UTF-8 safe.

    Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

repeated .google.cloud.retail.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;

Parameter
Name Description
index int
Returns
Type Description
CompleteQueryResponse.RecentSearchResultOrBuilder

getRecentSearchResultsOrBuilderList()

public List<? extends CompleteQueryResponse.RecentSearchResultOrBuilder> getRecentSearchResultsOrBuilderList()

Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it.

This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules:

  • They are ordered from latest to oldest.

  • They are matched with CompleteQueryRequest.query case insensitively.

  • They are transformed to lower case.

  • They are UTF-8 safe.

    Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

repeated .google.cloud.retail.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;

Returns
Type Description
List<? extends com.google.cloud.retail.v2alpha.CompleteQueryResponse.RecentSearchResultOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CompleteQueryResponse.Builder newBuilderForType()
Returns
Type Description
CompleteQueryResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompleteQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CompleteQueryResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CompleteQueryResponse.Builder toBuilder()
Returns
Type Description
CompleteQueryResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException