Package com.azure.search.documents.models

Class ScoringParameter

java.lang.Object

com.azure.search.documents.models.ScoringParameter

public final class ScoringParameter
extends Object

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

Constructor Summary

Constructors

Constructor	Description
ScoringParameter(String nameValuePair)	Constructor to take name value pair string of ScoringParameter.
ScoringParameter(String name, com.azure.core.models.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	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 class java.lang.Object

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

Constructor Detail

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,
                        List<String> 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.

Throws:

NullPointerException - if name or values is null.

ScoringParameter

public ScoringParameter(String name,
                        com.azure.core.models.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.

Throws:

NullPointerException - If value is null.

Method Detail

getName

public String getName()

Gets the name of the scoring parameter.

Returns:

The name of scoring parameter.

getValues

public List<String> getValues()

Gets the values of the scoring parameter.

Returns:

The values of scoring parameter.

toString

public String toString()

Covert ScoringParameter to string.

Overrides:

toString in class Object

Returns:

Service accepted string format.

Throws:

IllegalArgumentException - if all values in the list are null or empty.