com.google.cloud.retail.v2

Interface SearchRequest.QueryExpansionSpecOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchRequest.QueryExpansionSpec, SearchRequest.QueryExpansionSpec.Builder

Enclosing class:

SearchRequest

public static interface SearchRequest.QueryExpansionSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
SearchRequest.QueryExpansionSpec.Condition	getCondition() The condition under which query expansion should occur.
int	getConditionValue() The condition under which query expansion should occur.
boolean	getPinUnexpandedResults() Whether to pin unexpanded results.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getConditionValue

int getConditionValue()

 The condition under which query expansion should occur. Default to
 [Condition.DISABLED][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
 

.google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Returns:

The enum numeric value on the wire for condition.

getCondition

SearchRequest.QueryExpansionSpec.Condition getCondition()

 The condition under which query expansion should occur. Default to
 [Condition.DISABLED][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
 

.google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Returns:

The condition.

getPinUnexpandedResults

boolean getPinUnexpandedResults()

 Whether to pin unexpanded results. If this field is set to true,
 unexpanded products are always at the top of the search results, followed
 by the expanded results.
 

bool pin_unexpanded_results = 2;

Returns:

The pinUnexpandedResults.