Package com.google.firestore.admin.v1

Enum Index.IndexField.SearchConfig.TextIndexType

java.lang.Object
java.lang.Enum<Index.IndexField.SearchConfig.TextIndexType>
com.google.firestore.admin.v1.Index.IndexField.SearchConfig.TextIndexType
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Index.IndexField.SearchConfig.TextIndexType>
Enclosing class:
Index.IndexField.SearchConfig
public static enum Index.IndexField.SearchConfig.TextIndexType extends Enum<Index.IndexField.SearchConfig.TextIndexType> implements com.google.protobuf.ProtocolMessageEnum
 Ways to index the text field value.
Protobuf enum google.firestore.admin.v1.Index.IndexField.SearchConfig.TextIndexType

  • Enum Constant Details

  • Field Details

    • TEXT_INDEX_TYPE_UNSPECIFIED_VALUE

      public static final int TEXT_INDEX_TYPE_UNSPECIFIED_VALUE
       The index type is unspecified. Not a valid option.
      TEXT_INDEX_TYPE_UNSPECIFIED = 0;
      See Also:

    • TOKENIZED_VALUE

      public static final int TOKENIZED_VALUE
       Field values are tokenized. This is the only way currently supported
 for MONGODB_COMPATIBLE_API.
      TOKENIZED = 1;
      See Also:

  • Method Details

    • values

      public static Index.IndexField.SearchConfig.TextIndexType[] 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 Index.IndexField.SearchConfig.TextIndexType 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 Index.IndexField.SearchConfig.TextIndexType 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 Index.IndexField.SearchConfig.TextIndexType 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<Index.IndexField.SearchConfig.TextIndexType> 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 Index.IndexField.SearchConfig.TextIndexType 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