Package com.azure.analytics.purview.datamap.models

Class SearchHighlights

java.lang.Object
com.azure.analytics.purview.datamap.models.SearchHighlights
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchHighlights>
public final class SearchHighlights extends Object implements com.azure.json.JsonSerializable<SearchHighlights>
A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.

  • Method Details

    • getId

      public List<String> getId()
      Get the id property: Id.
      Returns:
      the id value.

    • getQualifiedName

      public List<String> getQualifiedName()
      Get the qualifiedName property: Qualified name.
      Returns:
      the qualifiedName value.

    • getName

      public List<String> getName()
      Get the name property: Name.
      Returns:
      the name value.

    • getDescription

      public List<String> getDescription()
      Get the description property: Description.
      Returns:
      the description value.

    • getEntityType

      public List<String> getEntityType()
      Get the entityType property: Entity type.
      Returns:
      the entityType value.

    • toJson

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

    • fromJson

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