Class CompleteQueryResponse.Builder (2.53.0) 

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

Response of the autocomplete query.

Protobuf type google.cloud.retail.v2beta.CompleteQueryResponse

Inheritance

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

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.retail.v2beta.CompleteQueryResponse.CompletionResult>
Returns
Type Description
CompleteQueryResponse.Builder

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

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

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Parameter
Name Description
values Iterable<? extends com.google.cloud.retail.v2beta.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.v2beta.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.v2beta.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.v2beta.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.v2beta.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.v2beta.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.v2beta.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
Name Description
index int
Returns
Type Description
CompleteQueryResponse.CompletionResult.Builder

addRecentSearchResults(CompleteQueryResponse.RecentSearchResult value) (deprecated)

public CompleteQueryResponse.Builder addRecentSearchResults(CompleteQueryResponse.RecentSearchResult value)

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Parameter
Name Description
value CompleteQueryResponse.RecentSearchResult
Returns
Type Description
CompleteQueryResponse.Builder

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

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

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Parameter
Name Description
builderForValue CompleteQueryResponse.RecentSearchResult.Builder
Returns
Type Description
CompleteQueryResponse.Builder

addRecentSearchResults(int index, CompleteQueryResponse.RecentSearchResult value) (deprecated)

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

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Parameters
Name Description
index int
value CompleteQueryResponse.RecentSearchResult
Returns
Type Description
CompleteQueryResponse.Builder

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

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

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Parameters
Name Description
index int
builderForValue CompleteQueryResponse.RecentSearchResult.Builder
Returns
Type Description
CompleteQueryResponse.Builder

addRecentSearchResultsBuilder() (deprecated)

public CompleteQueryResponse.RecentSearchResult.Builder addRecentSearchResultsBuilder()

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Returns
Type Description
CompleteQueryResponse.RecentSearchResult.Builder

addRecentSearchResultsBuilder(int index) (deprecated)

public CompleteQueryResponse.RecentSearchResult.Builder addRecentSearchResultsBuilder(int index)

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

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

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

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.v2beta.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

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CompleteQueryResponse.Builder
Overrides

clearRecentSearchResults() (deprecated)

public CompleteQueryResponse.Builder clearRecentSearchResults()

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Returns
Type Description
CompleteQueryResponse.Builder

clone()

public CompleteQueryResponse.Builder clone()
Returns
Type Description
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
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.v2beta.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.v2beta.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.v2beta.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.v2beta.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.v2beta.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.v2beta.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.v2beta.CompleteQueryResponse.CompletionResult completion_results = 1;

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

getDefaultInstanceForType()

public CompleteQueryResponse getDefaultInstanceForType()
Returns
Type Description
CompleteQueryResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getRecentSearchResults(int index) (deprecated)

public CompleteQueryResponse.RecentSearchResult getRecentSearchResults(int index)

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
CompleteQueryResponse.RecentSearchResult

getRecentSearchResultsBuilder(int index) (deprecated)

public CompleteQueryResponse.RecentSearchResult.Builder getRecentSearchResultsBuilder(int index)

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
CompleteQueryResponse.RecentSearchResult.Builder

getRecentSearchResultsBuilderList() (deprecated)

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

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Returns
Type Description
List<Builder>

getRecentSearchResultsCount() (deprecated)

public int getRecentSearchResultsCount()

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Returns
Type Description
int

getRecentSearchResultsList() (deprecated)

public List<CompleteQueryResponse.RecentSearchResult> getRecentSearchResultsList()

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Returns
Type Description
List<RecentSearchResult>

getRecentSearchResultsOrBuilder(int index) (deprecated)

public CompleteQueryResponse.RecentSearchResultOrBuilder getRecentSearchResultsOrBuilder(int index)

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
CompleteQueryResponse.RecentSearchResultOrBuilder

getRecentSearchResultsOrBuilderList() (deprecated)

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

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CompleteQueryResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CompleteQueryResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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.v2beta.CompleteQueryResponse.CompletionResult completion_results = 1;

Parameter
Name Description
index int
Returns
Type Description
CompleteQueryResponse.Builder

removeRecentSearchResults(int index) (deprecated)

public CompleteQueryResponse.Builder removeRecentSearchResults(int index)

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

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.v2beta.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.v2beta.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

setRecentSearchResults(int index, CompleteQueryResponse.RecentSearchResult value) (deprecated)

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

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

Parameters
Name Description
index int
value CompleteQueryResponse.RecentSearchResult
Returns
Type Description
CompleteQueryResponse.Builder

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

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

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

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.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

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

setUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CompleteQueryResponse.Builder
Overrides