Package com.google.cloud.retail.v2

Enum SearchRequest.SearchMode

java.lang.Object

java.lang.Enum<SearchRequest.SearchMode>

com.google.cloud.retail.v2.SearchRequest.SearchMode

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SearchRequest.SearchMode>

Enclosing class:

SearchRequest

public static enum SearchRequest.SearchMode
extends Enum<SearchRequest.SearchMode>
implements com.google.protobuf.ProtocolMessageEnum

 The search mode of each search request.
 

Protobuf enum google.cloud.retail.v2.SearchRequest.SearchMode

Enum Constant Summary

Enum Constants

Enum Constant	Description
FACETED_SEARCH_ONLY	Only faceted search will be performed.
PRODUCT_SEARCH_ONLY	Only product search will be performed.
SEARCH_MODE_UNSPECIFIED	Default value.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static int	FACETED_SEARCH_ONLY_VALUE	Only faceted search will be performed.
static int	PRODUCT_SEARCH_ONLY_VALUE	Only product search will be performed.
static int	SEARCH_MODE_UNSPECIFIED_VALUE	Default value.

Method Summary

Modifier and Type	Method	Description
static SearchRequest.SearchMode	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<SearchRequest.SearchMode>	internalGetValueMap()
static SearchRequest.SearchMode	valueOf(int value)	Deprecated.
static SearchRequest.SearchMode	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static SearchRequest.SearchMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SearchRequest.SearchMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SEARCH_MODE_UNSPECIFIED

public static final SearchRequest.SearchMode SEARCH_MODE_UNSPECIFIED

 Default value. In this case both product search and faceted search will
 be performed. Both
 [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult]
 and [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet]
 will be returned.
 

SEARCH_MODE_UNSPECIFIED = 0;

PRODUCT_SEARCH_ONLY

public static final SearchRequest.SearchMode PRODUCT_SEARCH_ONLY

 Only product search will be performed. The faceted search will be
 disabled.

 Only
 [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult]
 will be returned.
 [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet] will
 not be returned, even if
 [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs]
 or
 [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2.SearchRequest.dynamic_facet_spec]
 is set.
 

PRODUCT_SEARCH_ONLY = 1;

FACETED_SEARCH_ONLY

public static final SearchRequest.SearchMode FACETED_SEARCH_ONLY

 Only faceted search will be performed. The product search will be
 disabled.

 When in this mode, one or both of
 [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs]
 and
 [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2.SearchRequest.dynamic_facet_spec]
 should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only
 [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet] will
 be returned.
 [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult]
 will not be returned.
 

FACETED_SEARCH_ONLY = 2;

UNRECOGNIZED

public static final SearchRequest.SearchMode UNRECOGNIZED

Field Detail

SEARCH_MODE_UNSPECIFIED_VALUE

public static final int SEARCH_MODE_UNSPECIFIED_VALUE

 Default value. In this case both product search and faceted search will
 be performed. Both
 [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult]
 and [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet]
 will be returned.
 

SEARCH_MODE_UNSPECIFIED = 0;

See Also:

Constant Field Values

PRODUCT_SEARCH_ONLY_VALUE

public static final int PRODUCT_SEARCH_ONLY_VALUE

 Only product search will be performed. The faceted search will be
 disabled.

 Only
 [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult]
 will be returned.
 [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet] will
 not be returned, even if
 [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs]
 or
 [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2.SearchRequest.dynamic_facet_spec]
 is set.
 

PRODUCT_SEARCH_ONLY = 1;

See Also:

Constant Field Values

FACETED_SEARCH_ONLY_VALUE

public static final int FACETED_SEARCH_ONLY_VALUE

 Only faceted search will be performed. The product search will be
 disabled.

 When in this mode, one or both of
 [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs]
 and
 [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2.SearchRequest.dynamic_facet_spec]
 should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only
 [SearchResponse.Facet][google.cloud.retail.v2.SearchResponse.Facet] will
 be returned.
 [SearchResponse.SearchResult][google.cloud.retail.v2.SearchResponse.SearchResult]
 will not be returned.
 

FACETED_SEARCH_ONLY = 2;

See Also:

Constant Field Values

Method Detail

values

public static SearchRequest.SearchMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SearchRequest.SearchMode c : SearchRequest.SearchMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SearchRequest.SearchMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static SearchRequest.SearchMode valueOf(int value)

Deprecated.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

value - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

forNumber

public static SearchRequest.SearchMode forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<SearchRequest.SearchMode> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static SearchRequest.SearchMode valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

desc - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null