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 ConstantsEnum ConstantDescriptionUnspecified AttributeType.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 of the numerical field will be used to dynamically update the boost amount. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intUnspecified AttributeType.static final intFor the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified.static final intThe value of the numerical field will be used to dynamically update the boost amount. -
Method Summary
Modifier and TypeMethodDescriptionforNumber(int value) static com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType>valueOf(int value) Deprecated.valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.Returns the enum constant of this type with the specified name.values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
ATTRIBUTE_TYPE_UNSPECIFIED
public static final SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType ATTRIBUTE_TYPE_UNSPECIFIEDUnspecified AttributeType.
ATTRIBUTE_TYPE_UNSPECIFIED = 0; -
NUMERICAL
public static final SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType NUMERICALThe 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 FRESHNESSFor 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 Details
-
ATTRIBUTE_TYPE_UNSPECIFIED_VALUE
public static final int ATTRIBUTE_TYPE_UNSPECIFIED_VALUEUnspecified AttributeType.
ATTRIBUTE_TYPE_UNSPECIFIED = 0;- See Also:
-
NUMERICAL_VALUE
public static final int NUMERICAL_VALUEThe 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:
-
FRESHNESS_VALUE
public static final int FRESHNESS_VALUEFor 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:
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- 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 nameNullPointerException- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
@Deprecated public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType 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 nameNullPointerException- if the argument is null
-
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:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
public static SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType 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 nameNullPointerException- if the argument is null
-