MicrosoftLanguageTokenizer.java

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is
// regenerated.

package com.azure.search.documents.models;

import com.azure.core.annotation.Fluent;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * Divides text using language-specific rules.
 */
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "@odata.type")
@JsonTypeName("#Microsoft.Azure.Search.MicrosoftLanguageTokenizer")
@Fluent
public final class MicrosoftLanguageTokenizer extends Tokenizer {
    /*
     * The maximum token length. Tokens longer than the maximum length are
     * split. Maximum token length that can be used is 300 characters. Tokens
     * longer than 300 characters are first split into tokens of length 300 and
     * then each of those tokens is split based on the max token length set.
     * Default is 255.
     */
    @JsonProperty(value = "maxTokenLength")
    private Integer maxTokenLength;

    /*
     * A value indicating how the tokenizer is used. Set to true if used as the
     * search tokenizer, set to false if used as the indexing tokenizer.
     * Default is false.
     */
    @JsonProperty(value = "isSearchTokenizer")
    private Boolean isSearchTokenizer;

    /*
     * The language to use. The default is English. Possible values include:
     * 'bangla', 'bulgarian', 'catalan', 'chineseSimplified',
     * 'chineseTraditional', 'croatian', 'czech', 'danish', 'dutch', 'english',
     * 'french', 'german', 'greek', 'gujarati', 'hindi', 'icelandic',
     * 'indonesian', 'italian', 'japanese', 'kannada', 'korean', 'malay',
     * 'malayalam', 'marathi', 'norwegianBokmaal', 'polish', 'portuguese',
     * 'portugueseBrazilian', 'punjabi', 'romanian', 'russian',
     * 'serbianCyrillic', 'serbianLatin', 'slovenian', 'spanish', 'swedish',
     * 'tamil', 'telugu', 'thai', 'ukrainian', 'urdu', 'vietnamese'
     */
    @JsonProperty(value = "language")
    private MicrosoftTokenizerLanguage language;

    /**
     * Get the maxTokenLength property: The maximum token length. Tokens longer
     * than the maximum length are split. Maximum token length that can be used
     * is 300 characters. Tokens longer than 300 characters are first split
     * into tokens of length 300 and then each of those tokens is split based
     * on the max token length set. Default is 255.
     *
     * @return the maxTokenLength value.
     */
    public Integer getMaxTokenLength() {
        return this.maxTokenLength;
    }

    /**
     * Set the maxTokenLength property: The maximum token length. Tokens longer
     * than the maximum length are split. Maximum token length that can be used
     * is 300 characters. Tokens longer than 300 characters are first split
     * into tokens of length 300 and then each of those tokens is split based
     * on the max token length set. Default is 255.
     *
     * @param maxTokenLength the maxTokenLength value to set.
     * @return the MicrosoftLanguageTokenizer object itself.
     */
    public MicrosoftLanguageTokenizer setMaxTokenLength(Integer maxTokenLength) {
        this.maxTokenLength = maxTokenLength;
        return this;
    }

    /**
     * Get the isSearchTokenizer property: A value indicating how the tokenizer
     * is used. Set to true if used as the search tokenizer, set to false if
     * used as the indexing tokenizer. Default is false.
     *
     * @return the isSearchTokenizer value.
     */
    public Boolean isSearchTokenizer() {
        return this.isSearchTokenizer;
    }

    /**
     * Set the isSearchTokenizer property: A value indicating how the tokenizer
     * is used. Set to true if used as the search tokenizer, set to false if
     * used as the indexing tokenizer. Default is false.
     *
     * @param isSearchTokenizer the isSearchTokenizer value to set.
     * @return the MicrosoftLanguageTokenizer object itself.
     */
    public MicrosoftLanguageTokenizer setIsSearchTokenizer(Boolean isSearchTokenizer) {
        this.isSearchTokenizer = isSearchTokenizer;
        return this;
    }

    /**
     * Get the language property: The language to use. The default is English.
     * Possible values include: 'bangla', 'bulgarian', 'catalan',
     * 'chineseSimplified', 'chineseTraditional', 'croatian', 'czech',
     * 'danish', 'dutch', 'english', 'french', 'german', 'greek', 'gujarati',
     * 'hindi', 'icelandic', 'indonesian', 'italian', 'japanese', 'kannada',
     * 'korean', 'malay', 'malayalam', 'marathi', 'norwegianBokmaal', 'polish',
     * 'portuguese', 'portugueseBrazilian', 'punjabi', 'romanian', 'russian',
     * 'serbianCyrillic', 'serbianLatin', 'slovenian', 'spanish', 'swedish',
     * 'tamil', 'telugu', 'thai', 'ukrainian', 'urdu', 'vietnamese'.
     *
     * @return the language value.
     */
    public MicrosoftTokenizerLanguage getLanguage() {
        return this.language;
    }

    /**
     * Set the language property: The language to use. The default is English.
     * Possible values include: 'bangla', 'bulgarian', 'catalan',
     * 'chineseSimplified', 'chineseTraditional', 'croatian', 'czech',
     * 'danish', 'dutch', 'english', 'french', 'german', 'greek', 'gujarati',
     * 'hindi', 'icelandic', 'indonesian', 'italian', 'japanese', 'kannada',
     * 'korean', 'malay', 'malayalam', 'marathi', 'norwegianBokmaal', 'polish',
     * 'portuguese', 'portugueseBrazilian', 'punjabi', 'romanian', 'russian',
     * 'serbianCyrillic', 'serbianLatin', 'slovenian', 'spanish', 'swedish',
     * 'tamil', 'telugu', 'thai', 'ukrainian', 'urdu', 'vietnamese'.
     *
     * @param language the language value to set.
     * @return the MicrosoftLanguageTokenizer object itself.
     */
    public MicrosoftLanguageTokenizer setLanguage(MicrosoftTokenizerLanguage language) {
        this.language = language;
        return this;
    }
}