Package com.azure.search.documents.indexes.models

Class TruncateTokenFilter

java.lang.Object
com.azure.search.documents.indexes.models.TokenFilter
com.azure.search.documents.indexes.models.TruncateTokenFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<TokenFilter>
public final class TruncateTokenFilter extends TokenFilter
Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static TruncateTokenFilter
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of TruncateTokenFilter from the JsonReader.
    Integer
    getLength()
    Get the length property: The length at which terms will be truncated.
    String
    getOdataType()
    Get the odataType property: A URI fragment specifying the type of token filter.
    TruncateTokenFilter
    setLength(Integer length)
    Set the length property: The length at which terms will be truncated.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class com.azure.search.documents.indexes.models.TokenFilter

    getName

    Methods inherited from class java.lang.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

    • TruncateTokenFilter

      public TruncateTokenFilter(String name)
      Creates an instance of TruncateTokenFilter 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.
      Overrides:
      getOdataType in class TokenFilter
      Returns:
      the odataType value.

    • getLength

      public Integer getLength()
      Get the length property: The length at which terms will be truncated. Default and maximum is 300.
      Returns:
      the length value.

    • setLength

      public TruncateTokenFilter setLength(Integer length)
      Set the length property: The length at which terms will be truncated. Default and maximum is 300.
      Parameters:
      length - the length value to set.
      Returns:
      the TruncateTokenFilter object itself.

    • toJson

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

    • fromJson

      public static TruncateTokenFilter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of TruncateTokenFilter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of TruncateTokenFilter 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 TruncateTokenFilter.