Class TokenFilter

java.lang.Object
com.azure.search.documents.indexes.models.TokenFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<TokenFilter>
Direct Known Subclasses:
AsciiFoldingTokenFilter, CjkBigramTokenFilter, CommonGramTokenFilter, DictionaryDecompounderTokenFilter, EdgeNGramTokenFilter, ElisionTokenFilter, KeepTokenFilter, KeywordMarkerTokenFilter, LengthTokenFilter, LimitTokenFilter, NGramTokenFilter, PatternCaptureTokenFilter, PatternReplaceTokenFilter, PhoneticTokenFilter, ShingleTokenFilter, SnowballTokenFilter, StemmerOverrideTokenFilter, StemmerTokenFilter, StopwordsTokenFilter, SynonymTokenFilter, TruncateTokenFilter, UniqueTokenFilter, WordDelimiterTokenFilter
public class TokenFilter extends Object implements com.azure.json.JsonSerializable<TokenFilter>
Base type for token filters.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TokenFilter(String name)
    Creates an instance of TokenFilter class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static TokenFilter
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of TokenFilter from the JsonReader.
    String
    getName()
    Get the name property: The name of the token filter.
    String
    getOdataType()
    Get the odataType property: A URI fragment specifying the type of token filter.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • TokenFilter

      public TokenFilter(String name)
      Creates an instance of TokenFilter class.
      Parameters:
      name - the name value to set.

  • Method Details

    • getOdataType

      public String getOdataType()
      Get the odataType property: A URI fragment specifying the type of token filter.
      Returns:
      the odataType value.

    • getName

      public String getName()
      Get the name property: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.
      Returns:
      the name value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<TokenFilter>
      Throws:
      IOException

    • fromJson

      public static TokenFilter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of TokenFilter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of TokenFilter if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the TokenFilter.