Share via

TokenFilter Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.7.3
  • java.lang.Object
    • com.azure.search.documents.indexes.models.TokenFilter

Implements

JsonSerializable<TokenFilter>

public class TokenFilter
implements JsonSerializable<TokenFilter>

Base type for token filters.

Constructor Summary

Constructor Description
TokenFilter(String name)

Creates an instance of TokenFilter class.

Method Summary

Modifier and Type Method and Description
static TokenFilter fromJson(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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TokenFilter

public TokenFilter(String name)

Creates an instance of TokenFilter class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static TokenFilter fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

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.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of token filter.

Returns:

the odataType value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to