Package com.google.cloud.discoveryengine.v1beta

Enum SearchRequest.ContentSearchSpec.SearchResultMode

java.lang.Object
java.lang.Enum<SearchRequest.ContentSearchSpec.SearchResultMode>
com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SearchRequest.ContentSearchSpec.SearchResultMode>
Enclosing class:
SearchRequest.ContentSearchSpec
public static enum SearchRequest.ContentSearchSpec.SearchResultMode extends Enum<SearchRequest.ContentSearchSpec.SearchResultMode> implements com.google.protobuf.ProtocolMessageEnum
 Specifies the search result mode. If unspecified, the
 search result mode defaults to `DOCUMENTS`.
Protobuf enum google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode

  • Enum Constant Details

  • Field Details

    • SEARCH_RESULT_MODE_UNSPECIFIED_VALUE

      public static final int SEARCH_RESULT_MODE_UNSPECIFIED_VALUE
       Default value.
      SEARCH_RESULT_MODE_UNSPECIFIED = 0;
      See Also:

    • DOCUMENTS_VALUE

      public static final int DOCUMENTS_VALUE
       Returns documents in the search result.
      DOCUMENTS = 1;
      See Also:

    • CHUNKS_VALUE

      public static final int CHUNKS_VALUE
       Returns chunks in the search result. Only available if the
 [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
      CHUNKS = 2;
      See Also:

  • Method Details

    • values

      public static SearchRequest.ContentSearchSpec.SearchResultMode[] 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.ContentSearchSpec.SearchResultMode 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.ContentSearchSpec.SearchResultMode 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.ContentSearchSpec.SearchResultMode 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.ContentSearchSpec.SearchResultMode> 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.ContentSearchSpec.SearchResultMode 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