Package com.google.cloud.discoveryengine.v1

Enum SearchRequest.QueryExpansionSpec.Condition

java.lang.Object

java.lang.Enum<SearchRequest.QueryExpansionSpec.Condition>

com.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition

All Implemented Interfaces:

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

Enclosing class:

SearchRequest.QueryExpansionSpec

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

 Enum describing under which condition query expansion should occur.
 

Protobuf enum google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	Automatic query expansion built by the Search API.
CONDITION_UNSPECIFIED	Unspecified query expansion condition.
DISABLED	Disabled query expansion.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static int	AUTO_VALUE	Automatic query expansion built by the Search API.
static int	CONDITION_UNSPECIFIED_VALUE	Unspecified query expansion condition.
static int	DISABLED_VALUE	Disabled query expansion.

Method Summary

Modifier and Type	Method	Description
static SearchRequest.QueryExpansionSpec.Condition	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.QueryExpansionSpec.Condition>	internalGetValueMap()
static SearchRequest.QueryExpansionSpec.Condition	valueOf(int value)	Deprecated.
static SearchRequest.QueryExpansionSpec.Condition	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static SearchRequest.QueryExpansionSpec.Condition	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SearchRequest.QueryExpansionSpec.Condition[]	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

CONDITION_UNSPECIFIED

public static final SearchRequest.QueryExpansionSpec.Condition CONDITION_UNSPECIFIED

 Unspecified query expansion condition. In this case, server behavior
 defaults to
 [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
 

CONDITION_UNSPECIFIED = 0;

DISABLED

public static final SearchRequest.QueryExpansionSpec.Condition DISABLED

 Disabled query expansion. Only the exact search query is used, even if
 [SearchResponse.total_size][google.cloud.discoveryengine.v1.SearchResponse.total_size]
 is zero.
 

DISABLED = 1;

AUTO

public static final SearchRequest.QueryExpansionSpec.Condition AUTO

 Automatic query expansion built by the Search API.
 

AUTO = 2;

UNRECOGNIZED

public static final SearchRequest.QueryExpansionSpec.Condition UNRECOGNIZED

Field Detail

CONDITION_UNSPECIFIED_VALUE

public static final int CONDITION_UNSPECIFIED_VALUE

 Unspecified query expansion condition. In this case, server behavior
 defaults to
 [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
 

CONDITION_UNSPECIFIED = 0;

See Also:

Constant Field Values

DISABLED_VALUE

public static final int DISABLED_VALUE

 Disabled query expansion. Only the exact search query is used, even if
 [SearchResponse.total_size][google.cloud.discoveryengine.v1.SearchResponse.total_size]
 is zero.
 

DISABLED = 1;

See Also:

Constant Field Values

AUTO_VALUE

public static final int AUTO_VALUE

 Automatic query expansion built by the Search API.
 

AUTO = 2;

See Also:

Constant Field Values

Method Detail

values

public static SearchRequest.QueryExpansionSpec.Condition[] 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.QueryExpansionSpec.Condition c : SearchRequest.QueryExpansionSpec.Condition.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.QueryExpansionSpec.Condition 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.QueryExpansionSpec.Condition 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.QueryExpansionSpec.Condition 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.QueryExpansionSpec.Condition> 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.QueryExpansionSpec.Condition 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