Class CompleteQueryResponse.Builder (2.38.0)

Version 2.38.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public static final class CompleteQueryResponse.Builder extends GeneratedMessageV3.Builder<CompleteQueryResponse.Builder> implements CompleteQueryResponseOrBuilder

Response of the autocomplete query.

Protobuf type google.cloud.retail.v2alpha.CompleteQueryResponse

Inheritance

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

Implements

CompleteQueryResponseOrBuilder

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)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

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

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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

addAllCompletionResults(Iterable<? extends CompleteQueryResponse.CompletionResult> values)

public CompleteQueryResponse.Builder addAllCompletionResults(Iterable<? extends CompleteQueryResponse.CompletionResult> values)

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
values	Iterable<? extends com.google.cloud.retail.v2alpha.CompleteQueryResponse.CompletionResult>

Returns
Type	Description
CompleteQueryResponse.Builder

addAllRecentSearchResults(Iterable<? extends CompleteQueryResponse.RecentSearchResult> values)

public CompleteQueryResponse.Builder addAllRecentSearchResults(Iterable<? extends CompleteQueryResponse.RecentSearchResult> values)

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
values	Iterable<? extends com.google.cloud.retail.v2alpha.CompleteQueryResponse.RecentSearchResult>

Returns
Type	Description
CompleteQueryResponse.Builder

addCompletionResults(CompleteQueryResponse.CompletionResult value)

public CompleteQueryResponse.Builder addCompletionResults(CompleteQueryResponse.CompletionResult value)

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
value	CompleteQueryResponse.CompletionResult

Returns
Type	Description
CompleteQueryResponse.Builder

addCompletionResults(CompleteQueryResponse.CompletionResult.Builder builderForValue)

public CompleteQueryResponse.Builder addCompletionResults(CompleteQueryResponse.CompletionResult.Builder builderForValue)

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
builderForValue	CompleteQueryResponse.CompletionResult.Builder

Returns
Type	Description
CompleteQueryResponse.Builder

addCompletionResults(int index, CompleteQueryResponse.CompletionResult value)

public CompleteQueryResponse.Builder addCompletionResults(int index, CompleteQueryResponse.CompletionResult value)

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;

Parameters
Name	Description
index	int
value	CompleteQueryResponse.CompletionResult

Returns
Type	Description
CompleteQueryResponse.Builder

addCompletionResults(int index, CompleteQueryResponse.CompletionResult.Builder builderForValue)

public CompleteQueryResponse.Builder addCompletionResults(int index, CompleteQueryResponse.CompletionResult.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	CompleteQueryResponse.CompletionResult.Builder

Returns
Type	Description
CompleteQueryResponse.Builder

addCompletionResultsBuilder()

public CompleteQueryResponse.CompletionResult.Builder addCompletionResultsBuilder()

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
CompleteQueryResponse.CompletionResult.Builder

addCompletionResultsBuilder(int index)

public CompleteQueryResponse.CompletionResult.Builder addCompletionResultsBuilder(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.Builder

addRecentSearchResults(CompleteQueryResponse.RecentSearchResult value)

public CompleteQueryResponse.Builder addRecentSearchResults(CompleteQueryResponse.RecentSearchResult value)

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
value	CompleteQueryResponse.RecentSearchResult

Returns
Type	Description
CompleteQueryResponse.Builder

addRecentSearchResults(CompleteQueryResponse.RecentSearchResult.Builder builderForValue)

public CompleteQueryResponse.Builder addRecentSearchResults(CompleteQueryResponse.RecentSearchResult.Builder builderForValue)

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
builderForValue	CompleteQueryResponse.RecentSearchResult.Builder

Returns
Type	Description
CompleteQueryResponse.Builder

addRecentSearchResults(int index, CompleteQueryResponse.RecentSearchResult value)

public CompleteQueryResponse.Builder addRecentSearchResults(int index, CompleteQueryResponse.RecentSearchResult value)

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;

Parameters
Name	Description
index	int
value	CompleteQueryResponse.RecentSearchResult

Returns
Type	Description
CompleteQueryResponse.Builder

addRecentSearchResults(int index, CompleteQueryResponse.RecentSearchResult.Builder builderForValue)

public CompleteQueryResponse.Builder addRecentSearchResults(int index, CompleteQueryResponse.RecentSearchResult.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	CompleteQueryResponse.RecentSearchResult.Builder

Returns
Type	Description
CompleteQueryResponse.Builder

addRecentSearchResultsBuilder()

public CompleteQueryResponse.RecentSearchResult.Builder addRecentSearchResultsBuilder()

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
CompleteQueryResponse.RecentSearchResult.Builder

addRecentSearchResultsBuilder(int index)

public CompleteQueryResponse.RecentSearchResult.Builder addRecentSearchResultsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CompleteQueryResponse build()

Returns
Type	Description
CompleteQueryResponse

buildPartial()

public CompleteQueryResponse buildPartial()

Returns
Type	Description
CompleteQueryResponse

clear()

public CompleteQueryResponse.Builder clear()

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAttributeResults()

public CompleteQueryResponse.Builder clearAttributeResults()

Returns
Type	Description
CompleteQueryResponse.Builder

clearAttributionToken()

public CompleteQueryResponse.Builder clearAttributionToken()

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
CompleteQueryResponse.Builder	This builder for chaining.

clearCompletionResults()

public CompleteQueryResponse.Builder clearCompletionResults()

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
CompleteQueryResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public CompleteQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRecentSearchResults()

public CompleteQueryResponse.Builder clearRecentSearchResults()

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
CompleteQueryResponse.Builder

clone()

public CompleteQueryResponse.Builder clone()

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

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

getCompletionResultsBuilder(int index)

public CompleteQueryResponse.CompletionResult.Builder getCompletionResultsBuilder(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.Builder

getCompletionResultsBuilderList()

public List<CompleteQueryResponse.CompletionResult.Builder> getCompletionResultsBuilderList()

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<Builder>

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMutableAttributeResults() (deprecated)

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

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,AttributeResult>

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

getRecentSearchResultsBuilder(int index)

public CompleteQueryResponse.RecentSearchResult.Builder getRecentSearchResultsBuilder(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.Builder

getRecentSearchResultsBuilderList()

public List<CompleteQueryResponse.RecentSearchResult.Builder> getRecentSearchResultsBuilderList()

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<Builder>

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CompleteQueryResponse other)

public CompleteQueryResponse.Builder mergeFrom(CompleteQueryResponse other)

Parameter
Name	Description
other	CompleteQueryResponse

Returns
Type	Description
CompleteQueryResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CompleteQueryResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CompleteQueryResponse.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllAttributeResults(Map<String,CompleteQueryResponse.AttributeResult> values)

public CompleteQueryResponse.Builder putAllAttributeResults(Map<String,CompleteQueryResponse.AttributeResult> values)

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
values	Map<String,AttributeResult>

Returns
Type	Description
CompleteQueryResponse.Builder

putAttributeResults(String key, CompleteQueryResponse.AttributeResult value)

public CompleteQueryResponse.Builder putAttributeResults(String key, CompleteQueryResponse.AttributeResult value)

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
value	CompleteQueryResponse.AttributeResult

Returns
Type	Description
CompleteQueryResponse.Builder

putAttributeResultsBuilderIfAbsent(String key)

public CompleteQueryResponse.AttributeResult.Builder putAttributeResultsBuilderIfAbsent(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.Builder

removeAttributeResults(String key)

public CompleteQueryResponse.Builder removeAttributeResults(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.Builder

removeCompletionResults(int index)

public CompleteQueryResponse.Builder removeCompletionResults(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.Builder

removeRecentSearchResults(int index)

public CompleteQueryResponse.Builder removeRecentSearchResults(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.Builder

setAttributionToken(String value)

public CompleteQueryResponse.Builder setAttributionToken(String value)

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;

Parameter
Name	Description
value	String The attributionToken to set.

Returns
Type	Description
CompleteQueryResponse.Builder	This builder for chaining.

setAttributionTokenBytes(ByteString value)

public CompleteQueryResponse.Builder setAttributionTokenBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for attributionToken to set.

Returns
Type	Description
CompleteQueryResponse.Builder	This builder for chaining.

setCompletionResults(int index, CompleteQueryResponse.CompletionResult value)

public CompleteQueryResponse.Builder setCompletionResults(int index, CompleteQueryResponse.CompletionResult value)

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;

Parameters
Name	Description
index	int
value	CompleteQueryResponse.CompletionResult

Returns
Type	Description
CompleteQueryResponse.Builder

setCompletionResults(int index, CompleteQueryResponse.CompletionResult.Builder builderForValue)

public CompleteQueryResponse.Builder setCompletionResults(int index, CompleteQueryResponse.CompletionResult.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	CompleteQueryResponse.CompletionResult.Builder

Returns
Type	Description
CompleteQueryResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRecentSearchResults(int index, CompleteQueryResponse.RecentSearchResult value)

public CompleteQueryResponse.Builder setRecentSearchResults(int index, CompleteQueryResponse.RecentSearchResult value)

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;

Parameters
Name	Description
index	int
value	CompleteQueryResponse.RecentSearchResult

Returns
Type	Description
CompleteQueryResponse.Builder

setRecentSearchResults(int index, CompleteQueryResponse.RecentSearchResult.Builder builderForValue)

public CompleteQueryResponse.Builder setRecentSearchResults(int index, CompleteQueryResponse.RecentSearchResult.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	CompleteQueryResponse.RecentSearchResult.Builder

Returns
Type	Description
CompleteQueryResponse.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CompleteQueryResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CompleteQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)