Enum SearchRequest.RelevanceThreshold

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SearchRequest.RelevanceThreshold>
    Enclosing class:
    SearchRequest

    public static enum SearchRequest.RelevanceThreshold
    extends Enum<SearchRequest.RelevanceThreshold>
    implements com.google.protobuf.ProtocolMessageEnum
     The relevance threshold of the search results. The higher relevance
     threshold is, the higher relevant results are shown and the less number of
     results are returned.
     
    Protobuf enum google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold
    • Field Detail

      • RELEVANCE_THRESHOLD_UNSPECIFIED_VALUE

        public static final int RELEVANCE_THRESHOLD_UNSPECIFIED_VALUE
         Default value. In this case, server behavior defaults to
         [RelevanceThreshold.HIGH][google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold.HIGH].
         
        RELEVANCE_THRESHOLD_UNSPECIFIED = 0;
        See Also:
        Constant Field Values
      • HIGH_VALUE

        public static final int HIGH_VALUE
         High relevance threshold.
         
        HIGH = 1;
        See Also:
        Constant Field Values
      • MEDIUM_VALUE

        public static final int MEDIUM_VALUE
         Medium relevance threshold.
         
        MEDIUM = 2;
        See Also:
        Constant Field Values
      • LOW_VALUE

        public static final int LOW_VALUE
         Low relevance threshold.
         
        LOW = 3;
        See Also:
        Constant Field Values
      • LOWEST_VALUE

        public static final int LOWEST_VALUE
         Lowest relevance threshold.
         
        LOWEST = 4;
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static SearchRequest.RelevanceThreshold[] 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.RelevanceThreshold c : SearchRequest.RelevanceThreshold.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.RelevanceThreshold 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.RelevanceThreshold 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.RelevanceThreshold forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.
      • 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.RelevanceThreshold 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