public final class CompleteQueryResponse extends GeneratedMessageV3 implements CompleteQueryResponseOrBuilder
Response of the autocomplete query.
Protobuf type google.cloud.retail.v2alpha.CompleteQueryResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CompleteQueryResponse.Builder newBuilder()
newBuilder(CompleteQueryResponse prototype)
public static CompleteQueryResponse.Builder newBuilder(CompleteQueryResponse prototype)
public static CompleteQueryResponse parseDelimitedFrom(InputStream input)
public static CompleteQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CompleteQueryResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CompleteQueryResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseFrom(CodedInputStream input)
public static CompleteQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseFrom(InputStream input)
public static CompleteQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CompleteQueryResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CompleteQueryResponse> parser()
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:
map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAttributeResults() (deprecated)
public Map<String,CompleteQueryResponse.AttributeResult> getAttributeResults()
getAttributeResultsCount()
public int getAttributeResultsCount()
A map of matched attribute suggestions. This field is only available for
"cloud-retail" dataset.
Current supported keys:
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:
map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;
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:
map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;
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:
map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;
| Parameter |
| Name |
Description |
key |
String
|
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
|
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;
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
|
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()
getParserForType()
public Parser<CompleteQueryResponse> getParserForType()
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.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];
| Parameter |
| Name |
Description |
index |
int
|
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.v2alpha.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.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];
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.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];
| Parameter |
| Name |
Description |
index |
int
|
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.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.retail.v2alpha.CompleteQueryResponse.RecentSearchResultOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CompleteQueryResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CompleteQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CompleteQueryResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
