CharFilter Class

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

Implements

JsonSerializable<CharFilter>

public abstract class CharFilter
implements JsonSerializable<CharFilter>

Base type for character filters.

Constructor Summary

Constructor Description
CharFilter(String name)

Creates an instance of CharFilter class.

Method Summary

Modifier and Type Method and Description
static CharFilter fromJson(JsonReader jsonReader)

Reads an instance of CharFilter from the JsonReader.
String getName()

Get the name property: The name of the char filter.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CharFilter

public CharFilter(String name)

Creates an instance of CharFilter class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static CharFilter fromJson(JsonReader jsonReader)

Reads an instance of CharFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CharFilter 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 or the polymorphic discriminator.

getName

public String getName()

Get the name property: The name of the char 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 JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to