FieldMappingFunction 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.FieldMappingFunction

Implements

JsonSerializable<FieldMappingFunction>

public final class FieldMappingFunction
implements JsonSerializable<FieldMappingFunction>

Represents a function that transforms a value from a data source before indexing.

Constructor Summary

Constructor Description
FieldMappingFunction(String name)

Creates an instance of FieldMappingFunction class.

Method Summary

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

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

Get the name property: The name of the field mapping function.
Map<String,Object> getParameters()

Get the parameters property: A dictionary of parameter name/value pairs to pass to the function.
FieldMappingFunction setParameters(Map<String,Object> parameters)

Set the parameters property: A dictionary of parameter name/value pairs to pass to the function.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FieldMappingFunction

public FieldMappingFunction(String name)

Creates an instance of FieldMappingFunction class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static FieldMappingFunction fromJson(JsonReader jsonReader)

Reads an instance of FieldMappingFunction from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FieldMappingFunction 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 field mapping function.

Returns:

the name value.

getParameters

public Map getParameters()

Get the parameters property: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type.

Returns:

the parameters value.

setParameters

public FieldMappingFunction setParameters(Map parameters)

Set the parameters property: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type.

Parameters:

parameters - the parameters value to set.

Returns:

the FieldMappingFunction object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to