Class TagScoringParameters

java.lang.Object
com.azure.search.documents.indexes.models.TagScoringParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<TagScoringParameters>
public final class TagScoringParameters extends Object implements com.azure.json.JsonSerializable<TagScoringParameters>
Provides parameter values to a tag scoring function.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TagScoringParameters(String tagsParameter)
    Creates an instance of TagScoringParameters class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static TagScoringParameters
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of TagScoringParameters from the JsonReader.
    String
    getTagsParameter()
    Get the tagsParameter property: The name of the parameter passed in search queries to specify the list of tags to compare against the target field.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class 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

    • TagScoringParameters

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

  • Method Details

    • getTagsParameter

      public String getTagsParameter()
      Get the tagsParameter property: The name of the parameter passed in search queries to specify the list of tags to compare against the target field.
      Returns:
      the tagsParameter value.

    • toJson

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

    • fromJson

      public static TagScoringParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of TagScoringParameters from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of TagScoringParameters 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 TagScoringParameters.