### YamlMime:JavaType
uid: "com.azure.search.models.NGramTokenizer"
fullName: "com.azure.search.models.NGramTokenizer"
name: "NGramTokenizer"
nameWithType: "NGramTokenizer"
summary: "Tokenizes the input into n-grams of the given size(s)."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.models.Tokenizer?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.search.models.Tokenizer?alt=com.azure.search.models.Tokenizer&text=Tokenizer\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"com.azure.search.models.Tokenizer.getName()?alt=com.azure.search.models.Tokenizer.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.search.models.Tokenizer.setName(java.lang.String)?alt=com.azure.search.models.Tokenizer.setName&text=setName\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **NGramTokenizer**</br> extends <xref href=\"com.azure.search.models.Tokenizer?alt=com.azure.search.models.Tokenizer&text=Tokenizer\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.search.models.NGramTokenizer.NGramTokenizer()"
  fullName: "com.azure.search.models.NGramTokenizer.NGramTokenizer()"
  name: "NGramTokenizer()"
  nameWithType: "NGramTokenizer.NGramTokenizer()"
  syntax: "public NGramTokenizer()"
methods:
- uid: "com.azure.search.models.NGramTokenizer.getMaxGram()"
  fullName: "com.azure.search.models.NGramTokenizer.getMaxGram()"
  name: "getMaxGram()"
  nameWithType: "NGramTokenizer.getMaxGram()"
  summary: "Get the max<wbr>Gram property: The maximum n-gram length."
  syntax: "public Integer getMaxGram()"
  desc: "Get the maxGram property: The maximum n-gram length. Default is 2. Maximum is 300."
  returns:
    description: "the maxGram value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.models.NGramTokenizer.getMinGram()"
  fullName: "com.azure.search.models.NGramTokenizer.getMinGram()"
  name: "getMinGram()"
  nameWithType: "NGramTokenizer.getMinGram()"
  summary: "Get the min<wbr>Gram property: The minimum n-gram length."
  syntax: "public Integer getMinGram()"
  desc: "Get the minGram property: The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram."
  returns:
    description: "the minGram value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.models.NGramTokenizer.getTokenChars()"
  fullName: "com.azure.search.models.NGramTokenizer.getTokenChars()"
  name: "getTokenChars()"
  nameWithType: "NGramTokenizer.getTokenChars()"
  summary: "Get the token<wbr>Chars property: Character classes to keep in the tokens."
  syntax: "public List<TokenCharacterKind> getTokenChars()"
  desc: "Get the tokenChars property: Character classes to keep in the tokens."
  returns:
    description: "the tokenChars value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.TokenCharacterKind?alt=com.azure.search.models.TokenCharacterKind&text=TokenCharacterKind\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.models.NGramTokenizer.setMaxGram(java.lang.Integer)"
  fullName: "com.azure.search.models.NGramTokenizer.setMaxGram(Integer maxGram)"
  name: "setMaxGram(Integer maxGram)"
  nameWithType: "NGramTokenizer.setMaxGram(Integer maxGram)"
  summary: "Set the max<wbr>Gram property: The maximum n-gram length."
  parameters:
  - description: "the maxGram value to set."
    name: "maxGram"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public NGramTokenizer setMaxGram(Integer maxGram)"
  desc: "Set the maxGram property: The maximum n-gram length. Default is 2. Maximum is 300."
  returns:
    description: "the NGramTokenizer object itself."
    type: "<xref href=\"com.azure.search.models.NGramTokenizer?alt=com.azure.search.models.NGramTokenizer&text=NGramTokenizer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.NGramTokenizer.setMinGram(java.lang.Integer)"
  fullName: "com.azure.search.models.NGramTokenizer.setMinGram(Integer minGram)"
  name: "setMinGram(Integer minGram)"
  nameWithType: "NGramTokenizer.setMinGram(Integer minGram)"
  summary: "Set the min<wbr>Gram property: The minimum n-gram length."
  parameters:
  - description: "the minGram value to set."
    name: "minGram"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public NGramTokenizer setMinGram(Integer minGram)"
  desc: "Set the minGram property: The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram."
  returns:
    description: "the NGramTokenizer object itself."
    type: "<xref href=\"com.azure.search.models.NGramTokenizer?alt=com.azure.search.models.NGramTokenizer&text=NGramTokenizer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.NGramTokenizer.setTokenChars(java.util.List<com.azure.search.models.TokenCharacterKind>)"
  fullName: "com.azure.search.models.NGramTokenizer.setTokenChars(List<TokenCharacterKind> tokenChars)"
  name: "setTokenChars(List<TokenCharacterKind> tokenChars)"
  nameWithType: "NGramTokenizer.setTokenChars(List<TokenCharacterKind> tokenChars)"
  summary: "Set the token<wbr>Chars property: Character classes to keep in the tokens."
  parameters:
  - description: "the tokenChars value to set."
    name: "tokenChars"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.TokenCharacterKind?alt=com.azure.search.models.TokenCharacterKind&text=TokenCharacterKind\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public NGramTokenizer setTokenChars(List<TokenCharacterKind> tokenChars)"
  desc: "Set the tokenChars property: Character classes to keep in the tokens."
  returns:
    description: "the NGramTokenizer object itself."
    type: "<xref href=\"com.azure.search.models.NGramTokenizer?alt=com.azure.search.models.NGramTokenizer&text=NGramTokenizer\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene."
metadata: {}
package: "com.azure.search.models"
artifact: com.azure:azure-search:11.0.0-beta.1