Package com.azure.search.documents.indexes.models

Class SemanticField

java.lang.Object
com.azure.search.documents.indexes.models.SemanticField
All Implemented Interfaces:
com.azure.json.JsonSerializable<SemanticField>
public final class SemanticField extends Object implements com.azure.json.JsonSerializable<SemanticField>
A field that is used as part of the semantic configuration.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SemanticField(String fieldName)
    Creates an instance of SemanticField class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SemanticField
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of SemanticField from the JsonReader.
    String
    getFieldName()
    Get the fieldName property: The fieldName property.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • SemanticField

      public SemanticField(String fieldName)
      Creates an instance of SemanticField class.
      Parameters:
      fieldName - the fieldName value to set.

  • Method Details

    • getFieldName

      public String getFieldName()
      Get the fieldName property: The fieldName property.
      Returns:
      the fieldName value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<SemanticField>
      Throws:
      IOException

    • fromJson

      public static SemanticField fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of SemanticField from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of SemanticField if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the SemanticField.