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

Class FreshnessScoringParameters

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    FreshnessScoringParameters(Duration boostingDuration)
    Creates an instance of FreshnessScoringParameters class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static FreshnessScoringParameters
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of FreshnessScoringParameters from the JsonReader.
    Duration
    getBoostingDuration()
    Get the boostingDuration property: The expiration period after which boosting will stop for a particular document.
    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

    • FreshnessScoringParameters

      public FreshnessScoringParameters(Duration boostingDuration)
      Creates an instance of FreshnessScoringParameters class.
      Parameters:
      boostingDuration - the boostingDuration value to set.

  • Method Details

    • getBoostingDuration

      public Duration getBoostingDuration()
      Get the boostingDuration property: The expiration period after which boosting will stop for a particular document.
      Returns:
      the boostingDuration value.

    • toJson

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

    • fromJson

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