com.google.cloud.discoveryengine.v1beta

Enum SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

java.lang.Object

java.lang.Enum<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType>

com.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType>

Enclosing class:

SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec

public static enum SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType
extends Enum<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType>
implements com.google.protobuf.ProtocolMessageEnum

 The attribute(or function) for which the custom ranking is to be
 applied.
 

Protobuf enum google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTRIBUTE_TYPE_UNSPECIFIED Unspecified AttributeType.
FRESHNESS For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified.
NUMERICAL The value of the numerical field will be used to dynamically update the boost amount.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTE_TYPE_UNSPECIFIED_VALUE Unspecified AttributeType.
static int	FRESHNESS_VALUE For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified.
static int	NUMERICAL_VALUE The value of the numerical field will be used to dynamically update the boost amount.

Method Summary

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

ATTRIBUTE_TYPE_UNSPECIFIED

public static final SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType ATTRIBUTE_TYPE_UNSPECIFIED

 Unspecified AttributeType.
 

ATTRIBUTE_TYPE_UNSPECIFIED = 0;

NUMERICAL

public static final SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType NUMERICAL

 The value of the numerical field will be used to dynamically update
 the boost amount. In this case, the attribute_value (the x value)
 of the control point will be the actual value of the numerical
 field for which the boost_amount is specified.
 

NUMERICAL = 1;

FRESHNESS

public static final SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType FRESHNESS

 For the freshness use case the attribute value will be the duration
 between the current time and the date in the datetime field
 specified. The value must be formatted as an XSD `dayTimeDuration`
 value (a restricted subset of an ISO 8601 duration value). The
 pattern for this is: `[nD][T[nH][nM][nS]]`.
 For example, `5D`, `3DT12H30M`, `T24H`.
 

FRESHNESS = 2;

UNRECOGNIZED

public static final SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType UNRECOGNIZED

Field Detail

ATTRIBUTE_TYPE_UNSPECIFIED_VALUE

public static final int ATTRIBUTE_TYPE_UNSPECIFIED_VALUE

 Unspecified AttributeType.
 

ATTRIBUTE_TYPE_UNSPECIFIED = 0;

See Also:

Constant Field Values

NUMERICAL_VALUE

public static final int NUMERICAL_VALUE

 The value of the numerical field will be used to dynamically update
 the boost amount. In this case, the attribute_value (the x value)
 of the control point will be the actual value of the numerical
 field for which the boost_amount is specified.
 

NUMERICAL = 1;

See Also:

Constant Field Values

FRESHNESS_VALUE

public static final int FRESHNESS_VALUE

 For the freshness use case the attribute value will be the duration
 between the current time and the date in the datetime field
 specified. The value must be formatted as an XSD `dayTimeDuration`
 value (a restricted subset of an ISO 8601 duration value). The
 pattern for this is: `[nD][T[nH][nM][nS]]`.
 For example, `5D`, `3DT12H30M`, `T24H`.
 

FRESHNESS = 2;

See Also:

Constant Field Values

Method Detail

values

public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType[] 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.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType c : SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType.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.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType 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.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType 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.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType 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.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType> 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.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)