ScoringParameter Class

  • Reference
Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:11.7.3
  • java.lang.Object
    • com.azure.search.documents.models.ScoringParameter

public final class ScoringParameter

Represents a parameter value to be used in scoring functions (for example, referencePointParameter).

Constructor Summary

Constructor Description
ScoringParameter(String nameValuePair)

Constructor to take name value pair string of ScoringParameter.
ScoringParameter(String name, GeoPoint value)

Initializes a new instance of the ScoringParameter class with the given name and GeographyPoint value.
ScoringParameter(String name, List<String> values)

Initializes a new instance of the ScoringParameter class with the given name and string values.

Method Summary

Modifier and Type Method and Description
String getName()

Gets the name of the scoring parameter.
List<String> getValues()

Gets the values of the scoring parameter.
String toString()

Covert ScoringParameter to string.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ScoringParameter

public ScoringParameter(String nameValuePair)

Constructor to take name value pair string of ScoringParameter. Name and values are separated by dash, and values are separared by comma.

Parameters:

nameValuePair - The dash separated name value pairs.

ScoringParameter

public ScoringParameter(String name, GeoPoint value)

Initializes a new instance of the ScoringParameter class with the given name and GeographyPoint value.

Parameters:

name - Name of the scoring parameter.
value - Value of the scoring parameter.

ScoringParameter

public ScoringParameter(String name, List values)

Initializes a new instance of the ScoringParameter class with the given name and string values.

Parameters:

name - Name of the scoring parameter.
values - Values of the scoring parameter.

Method Details

getName

public String getName()

Gets the name of the scoring parameter.

Returns:

The name of scoring parameter.

getValues

public List getValues()

Gets the values of the scoring parameter.

Returns:

The values of scoring parameter.

toString

public String toString()

Covert ScoringParameter to string.

Overrides:

ScoringParameter.toString()

Returns:

Service accepted string format.

Applies to