Class CompleteQueryResponse (2.30.0)

public final class CompleteQueryResponse extends GeneratedMessageV3 implements CompleteQueryResponseOrBuilder

Response of the autocomplete query.

Protobuf type google.cloud.retail.v2alpha.CompleteQueryResponse

Inheritance

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

Implements

CompleteQueryResponseOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ATTRIBUTE_RESULTS_FIELD_NUMBER

public static final int ATTRIBUTE_RESULTS_FIELD_NUMBER

Field Value
Type	Description
`int`

ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER

Field Value
Type	Description
`int`

COMPLETION_RESULTS_FIELD_NUMBER

public static final int COMPLETION_RESULTS_FIELD_NUMBER

Field Value
Type	Description
`int`

RECENT_SEARCH_RESULTS_FIELD_NUMBER

public static final int RECENT_SEARCH_RESULTS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static CompleteQueryResponse getDefaultInstance()

Returns
Type	Description
`CompleteQueryResponse`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static CompleteQueryResponse.Builder newBuilder()

Returns
Type	Description
`CompleteQueryResponse.Builder`

newBuilder(CompleteQueryResponse prototype)

public static CompleteQueryResponse.Builder newBuilder(CompleteQueryResponse prototype)

Parameter
Name	Description
`prototype`	`CompleteQueryResponse`

Returns
Type	Description
`CompleteQueryResponse.Builder`

parseDelimitedFrom(InputStream input)

public static CompleteQueryResponse parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static CompleteQueryResponse parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static CompleteQueryResponse parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static CompleteQueryResponse parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static CompleteQueryResponse parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static CompleteQueryResponse parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CompleteQueryResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<CompleteQueryResponse> parser()

Returns
Type	Description
`Parser<CompleteQueryResponse>`

Methods

containsAttributeResults(String key)

public boolean containsAttributeResults(String key)

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

Current supported keys:

brands
categories

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAttributeResults()

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

Use #getAttributeResultsMap() instead.

Returns
Type	Description
`Map<String,AttributeResult>`

getAttributeResultsCount()

public int getAttributeResultsCount()

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

Current supported keys:

brands
categories

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

Returns
Type	Description
`int`

getAttributeResultsMap()

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

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

Current supported keys:

brands
categories

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

Returns
Type	Description
`Map<String,AttributeResult>`

getAttributeResultsOrDefault(String key, CompleteQueryResponse.AttributeResult defaultValue)

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

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

Current supported keys:

brands
categories

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

Parameters
Name	Description
`key`	`String`
`defaultValue`	`CompleteQueryResponse.AttributeResult`

Returns
Type	Description
`CompleteQueryResponse.AttributeResult`

getAttributeResultsOrThrow(String key)

public CompleteQueryResponse.AttributeResult getAttributeResultsOrThrow(String key)

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

Current supported keys:

brands
categories

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`CompleteQueryResponse.AttributeResult`

getAttributionToken()

public String getAttributionToken()

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

string attribution_token = 2;

Returns
Type	Description
`String`	The attributionToken.

getAttributionTokenBytes()

public ByteString getAttributionTokenBytes()

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

string attribution_token = 2;

Returns
Type	Description
`ByteString`	The bytes for attributionToken.

getCompletionResults(int index)

public CompleteQueryResponse.CompletionResult getCompletionResults(int index)

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

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CompleteQueryResponse.CompletionResult`

getCompletionResultsCount()

public int getCompletionResultsCount()

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

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

Returns
Type	Description
`int`

getCompletionResultsList()

public List<CompleteQueryResponse.CompletionResult> getCompletionResultsList()

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

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

Returns
Type	Description
`List<CompletionResult>`

getCompletionResultsOrBuilder(int index)

public CompleteQueryResponse.CompletionResultOrBuilder getCompletionResultsOrBuilder(int index)

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

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CompleteQueryResponse.CompletionResultOrBuilder`

getCompletionResultsOrBuilderList()

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

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

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

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

getDefaultInstanceForType()

public CompleteQueryResponse getDefaultInstanceForType()

Returns
Type	Description
`CompleteQueryResponse`

getParserForType()

public Parser<CompleteQueryResponse> getParserForType()

Returns
Type	Description
`Parser<CompleteQueryResponse>`

Overrides

GeneratedMessageV3.getParserForType()

getRecentSearchResults(int index)

public CompleteQueryResponse.RecentSearchResult getRecentSearchResults(int index)

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

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

They are ordered from latest to oldest.
They are matched with CompleteQueryRequest.query case insensitively.
They are transformed to lower case.
They are UTF-8 safe.

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

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CompleteQueryResponse.RecentSearchResult`

getRecentSearchResultsCount()

public int getRecentSearchResultsCount()

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

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

They are ordered from latest to oldest.
They are matched with CompleteQueryRequest.query case insensitively.
They are transformed to lower case.
They are UTF-8 safe.

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

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

Returns
Type	Description
`int`

getRecentSearchResultsList()

public List<CompleteQueryResponse.RecentSearchResult> getRecentSearchResultsList()

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

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

They are ordered from latest to oldest.
They are matched with CompleteQueryRequest.query case insensitively.
They are transformed to lower case.
They are UTF-8 safe.

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

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

Returns
Type	Description
`List<RecentSearchResult>`

getRecentSearchResultsOrBuilder(int index)

public CompleteQueryResponse.RecentSearchResultOrBuilder getRecentSearchResultsOrBuilder(int index)

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

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

They are ordered from latest to oldest.
They are matched with CompleteQueryRequest.query case insensitively.
They are transformed to lower case.
They are UTF-8 safe.

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

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CompleteQueryResponse.RecentSearchResultOrBuilder`

getRecentSearchResultsOrBuilderList()

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

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

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

They are ordered from latest to oldest.
They are matched with CompleteQueryRequest.query case insensitively.
They are transformed to lower case.
They are UTF-8 safe.

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

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

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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CompleteQueryResponse.Builder newBuilderForType()

Returns
Type	Description
`CompleteQueryResponse.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompleteQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CompleteQueryResponse.Builder toBuilder()

Returns
Type	Description
`CompleteQueryResponse.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`