com.google.cloud.discoveryengine.v1

Enum SearchRequest.DisplaySpec.MatchHighlightingCondition

java.lang.Object

java.lang.Enum<SearchRequest.DisplaySpec.MatchHighlightingCondition>

com.google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec.MatchHighlightingCondition

All Implemented Interfaces:

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

Enclosing class:

SearchRequest.DisplaySpec

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

 Enum describing under which condition match highlighting should occur.
 

Protobuf enum google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec.MatchHighlightingCondition

Enum Constant Summary

Enum Constants

Enum Constant and Description
MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.
MATCH_HIGHLIGHTING_DISABLED Disables match highlighting on all documents.
MATCH_HIGHLIGHTING_ENABLED Enables match highlighting on all documents.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED_VALUE Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.
static int	MATCH_HIGHLIGHTING_DISABLED_VALUE Disables match highlighting on all documents.
static int	MATCH_HIGHLIGHTING_ENABLED_VALUE Enables match highlighting on all documents.

Method Summary

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

MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED

public static final SearchRequest.DisplaySpec.MatchHighlightingCondition MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED

 Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.
 

MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED = 0;

MATCH_HIGHLIGHTING_DISABLED

public static final SearchRequest.DisplaySpec.MatchHighlightingCondition MATCH_HIGHLIGHTING_DISABLED

 Disables match highlighting on all documents.
 

MATCH_HIGHLIGHTING_DISABLED = 1;

MATCH_HIGHLIGHTING_ENABLED

public static final SearchRequest.DisplaySpec.MatchHighlightingCondition MATCH_HIGHLIGHTING_ENABLED

 Enables match highlighting on all documents.
 

MATCH_HIGHLIGHTING_ENABLED = 2;

UNRECOGNIZED

public static final SearchRequest.DisplaySpec.MatchHighlightingCondition UNRECOGNIZED

Field Detail

MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED_VALUE

public static final int MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED_VALUE

 Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.
 

MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED = 0;

See Also:

Constant Field Values

MATCH_HIGHLIGHTING_DISABLED_VALUE

public static final int MATCH_HIGHLIGHTING_DISABLED_VALUE

 Disables match highlighting on all documents.
 

MATCH_HIGHLIGHTING_DISABLED = 1;

See Also:

Constant Field Values

MATCH_HIGHLIGHTING_ENABLED_VALUE

public static final int MATCH_HIGHLIGHTING_ENABLED_VALUE

 Enables match highlighting on all documents.
 

MATCH_HIGHLIGHTING_ENABLED = 2;

See Also:

Constant Field Values

Method Detail

values

public static SearchRequest.DisplaySpec.MatchHighlightingCondition[] 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.DisplaySpec.MatchHighlightingCondition c : SearchRequest.DisplaySpec.MatchHighlightingCondition.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.DisplaySpec.MatchHighlightingCondition 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.DisplaySpec.MatchHighlightingCondition 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 SearchRequest.DisplaySpec.MatchHighlightingCondition 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.DisplaySpec.MatchHighlightingCondition> 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 com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

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