com.google.cloud.discoveryengine.v1beta

Enum SearchUseCase

java.lang.Object

java.lang.Enum<SearchUseCase>

com.google.cloud.discoveryengine.v1beta.SearchUseCase

All Implemented Interfaces:

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

public enum SearchUseCase
extends Enum<SearchUseCase>
implements com.google.protobuf.ProtocolMessageEnum

 Defines a further subdivision of `SolutionType`.
 Specifically applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

Protobuf enum google.cloud.discoveryengine.v1beta.SearchUseCase

Enum Constant Summary

Enum Constants

Enum Constant and Description
SEARCH_USE_CASE_BROWSE Browse use case.
SEARCH_USE_CASE_SEARCH Search use case.
SEARCH_USE_CASE_UNSPECIFIED Value used when unset.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	SEARCH_USE_CASE_BROWSE_VALUE Browse use case.
static int	SEARCH_USE_CASE_SEARCH_VALUE Search use case.
static int	SEARCH_USE_CASE_UNSPECIFIED_VALUE Value used when unset.

Method Summary

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

public static final SearchUseCase SEARCH_USE_CASE_UNSPECIFIED

 Value used when unset. Will not occur in CSS.
 

SEARCH_USE_CASE_UNSPECIFIED = 0;

SEARCH_USE_CASE_SEARCH

public static final SearchUseCase SEARCH_USE_CASE_SEARCH

 Search use case. Expects the traffic has a non-empty
 [query][google.cloud.discoveryengine.v1beta.SearchRequest.query].
 

SEARCH_USE_CASE_SEARCH = 1;

SEARCH_USE_CASE_BROWSE

public static final SearchUseCase SEARCH_USE_CASE_BROWSE

 Browse use case. Expects the traffic has an empty
 [query][google.cloud.discoveryengine.v1beta.SearchRequest.query].
 

SEARCH_USE_CASE_BROWSE = 2;

UNRECOGNIZED

public static final SearchUseCase UNRECOGNIZED

Field Detail

SEARCH_USE_CASE_UNSPECIFIED_VALUE

public static final int SEARCH_USE_CASE_UNSPECIFIED_VALUE

 Value used when unset. Will not occur in CSS.
 

SEARCH_USE_CASE_UNSPECIFIED = 0;

See Also:

Constant Field Values

SEARCH_USE_CASE_SEARCH_VALUE

public static final int SEARCH_USE_CASE_SEARCH_VALUE

 Search use case. Expects the traffic has a non-empty
 [query][google.cloud.discoveryengine.v1beta.SearchRequest.query].
 

SEARCH_USE_CASE_SEARCH = 1;

See Also:

Constant Field Values

SEARCH_USE_CASE_BROWSE_VALUE

public static final int SEARCH_USE_CASE_BROWSE_VALUE

 Browse use case. Expects the traffic has an empty
 [query][google.cloud.discoveryengine.v1beta.SearchRequest.query].
 

SEARCH_USE_CASE_BROWSE = 2;

See Also:

Constant Field Values

Method Detail

values

public static SearchUseCase[] 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 (SearchUseCase c : SearchUseCase.values())
    System.out.println(c);

Returns:

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

valueOf

public static SearchUseCase 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 SearchUseCase valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

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

Returns:

The enum associated with the given numeric wire value.

forNumber

public static SearchUseCase 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<SearchUseCase> 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 SearchUseCase valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)