Class CompleteQueryResponse.Builder (2.2.0)

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

Response of the auto-complete query.

Protobuf type google.cloud.retail.v2.CompleteQueryResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.retail.v2.CompleteQueryResponse.CompletionResult>
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.retail.v2.CompleteQueryResponse.RecentSearchResult>
Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
NameDescription
valueCompleteQueryResponse.CompletionResult
Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
NameDescription
builderForValueCompleteQueryResponse.CompletionResult.Builder
Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameters
NameDescription
indexint
valueCompleteQueryResponse.CompletionResult
Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameters
NameDescription
indexint
builderForValueCompleteQueryResponse.CompletionResult.Builder
Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameter
NameDescription
valueCompleteQueryResponse.RecentSearchResult
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameter
NameDescription
builderForValueCompleteQueryResponse.RecentSearchResult.Builder
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameters
NameDescription
indexint
valueCompleteQueryResponse.RecentSearchResult
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameters
NameDescription
indexint
builderForValueCompleteQueryResponse.RecentSearchResult.Builder
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CompleteQueryResponse.RecentSearchResult.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

build()

public CompleteQueryResponse build()
Returns
TypeDescription
CompleteQueryResponse

buildPartial()

public CompleteQueryResponse buildPartial()
Returns
TypeDescription
CompleteQueryResponse

clear()

public CompleteQueryResponse.Builder clear()
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

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
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Returns
TypeDescription
CompleteQueryResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public CompleteQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Returns
TypeDescription
CompleteQueryResponse.Builder

clone()

public CompleteQueryResponse.Builder clone()
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

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
TypeDescription
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
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Returns
TypeDescription
List<? extends com.google.cloud.retail.v2.CompleteQueryResponse.CompletionResultOrBuilder>

getDefaultInstanceForType()

public CompleteQueryResponse getDefaultInstanceForType()
Returns
TypeDescription
CompleteQueryResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Returns
TypeDescription
List<? extends com.google.cloud.retail.v2.CompleteQueryResponse.RecentSearchResultOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CompleteQueryResponse other)

public CompleteQueryResponse.Builder mergeFrom(CompleteQueryResponse other)
Parameter
NameDescription
otherCompleteQueryResponse
Returns
TypeDescription
CompleteQueryResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CompleteQueryResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CompleteQueryResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueString

The attributionToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for attributionToken to set.

Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameters
NameDescription
indexint
valueCompleteQueryResponse.CompletionResult
Returns
TypeDescription
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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameters
NameDescription
indexint
builderForValueCompleteQueryResponse.CompletionResult.Builder
Returns
TypeDescription
CompleteQueryResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameters
NameDescription
indexint
valueCompleteQueryResponse.RecentSearchResult
Returns
TypeDescription
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 cases.
  • They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

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

Parameters
NameDescription
indexint
builderForValueCompleteQueryResponse.RecentSearchResult.Builder
Returns
TypeDescription
CompleteQueryResponse.Builder

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

public CompleteQueryResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides