Package com.google.cloud.discoveryengine.v1

Enum SearchRequest.CrowdingSpec.Mode

java.lang.Object
java.lang.Enum<SearchRequest.CrowdingSpec.Mode>
com.google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SearchRequest.CrowdingSpec.Mode>
Enclosing class:
SearchRequest.CrowdingSpec
public static enum SearchRequest.CrowdingSpec.Mode extends Enum<SearchRequest.CrowdingSpec.Mode> implements com.google.protobuf.ProtocolMessageEnum
 Enum describing the mode to use for documents that are crowded away.
 They can be dropped or demoted to the later pages.
Protobuf enum google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode

  • Enum Constant Details

    • MODE_UNSPECIFIED

      public static final SearchRequest.CrowdingSpec.Mode MODE_UNSPECIFIED
       Unspecified crowding mode. In this case, server behavior defaults to
 [Mode.DROP_CROWDED_RESULTS][google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode.DROP_CROWDED_RESULTS].
      MODE_UNSPECIFIED = 0;

    • DROP_CROWDED_RESULTS

      public static final SearchRequest.CrowdingSpec.Mode DROP_CROWDED_RESULTS
       Drop crowded results.
      DROP_CROWDED_RESULTS = 1;

    • DEMOTE_CROWDED_RESULTS_TO_END

      public static final SearchRequest.CrowdingSpec.Mode DEMOTE_CROWDED_RESULTS_TO_END
       Demote crowded results to the later pages.
      DEMOTE_CROWDED_RESULTS_TO_END = 2;

    • UNRECOGNIZED

      public static final SearchRequest.CrowdingSpec.Mode UNRECOGNIZED

  • Field Details

    • MODE_UNSPECIFIED_VALUE

      public static final int MODE_UNSPECIFIED_VALUE
       Unspecified crowding mode. In this case, server behavior defaults to
 [Mode.DROP_CROWDED_RESULTS][google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode.DROP_CROWDED_RESULTS].
      MODE_UNSPECIFIED = 0;
      See Also:

    • DROP_CROWDED_RESULTS_VALUE

      public static final int DROP_CROWDED_RESULTS_VALUE
       Drop crowded results.
      DROP_CROWDED_RESULTS = 1;
      See Also:

    • DEMOTE_CROWDED_RESULTS_TO_END_VALUE

      public static final int DEMOTE_CROWDED_RESULTS_TO_END_VALUE
       Demote crowded results to the later pages.
      DEMOTE_CROWDED_RESULTS_TO_END = 2;
      See Also:

  • Method Details

    • values

      public static SearchRequest.CrowdingSpec.Mode[] 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.CrowdingSpec.Mode 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.CrowdingSpec.Mode 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.CrowdingSpec.Mode 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.CrowdingSpec.Mode> 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.CrowdingSpec.Mode 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