Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference

Class InferenceUtils

java.lang.Object

org.elasticsearch.xpack.core.inference.InferenceUtils

public class InferenceUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InferenceUtils.EnumConstructor<E extends Enum<E>>	Functional interface for creating an enum from a string.

Method Summary

Modifier and Type	Method	Description
static <E extends Enum<E>> E	extractOptionalEnum(Map<String,Object> map, String settingName, String scope, InferenceUtils.EnumConstructor<E> constructor, EnumSet<E> validValues, ValidationException validationException)
static <T> List<T>	extractOptionalList(Map<String,Object> map, String settingName, Class<T> type, ValidationException validationException)
static String	extractOptionalString(Map<String,Object> map, String settingName, String scope, ValidationException validationException)
static Integer	extractRequiredPositiveInteger(Map<String,Object> map, String settingName, String scope, ValidationException validationException)
static Integer	extractRequiredPositiveIntegerGreaterThanOrEqualToMin(Map<String,Object> map, String settingName, int minValue, String scope, ValidationException validationException)
static Integer	extractRequiredPositiveIntegerLessThanOrEqualToMax(Map<String,Object> map, String settingName, int maxValue, String scope, ValidationException validationException)
static String	invalidTypeErrorMsg(String settingName, Object foundObject, String expectedType)
static String	invalidValue(String settingName, String scope, String invalidType, String[] requiredValues)
static String	missingSettingErrorMsg(String settingName, String scope)
static String	mustBeAPositiveIntegerErrorMessage(String settingName, String scope, int value)
static String	mustBeGreaterThanOrEqualNumberErrorMessage(String settingName, String scope, double value, double minValue)
static String	mustBeLessThanOrEqualNumberErrorMessage(String settingName, String scope, double value, double maxValue)
static String	mustBeNonEmptyString(String settingName, String scope)
static <T> T	removeAsType(Map<String,Object> sourceMap, String key, Class<T> type, ValidationException validationException)	Remove the object from the map and cast to the expected type.

Methods inherited from class java.lang.Object

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

Method Details

removeAsType

public static <T> T removeAsType(Map<String,Object> sourceMap,
 String key,
 Class<T> type,
 ValidationException validationException)

Remove the object from the map and cast to the expected type. If the object cannot be cast to type and error is added to the validationException parameter

Type Parameters:

T - The expected type

Parameters:

sourceMap - Map containing fields

key - The key of the object to remove

type - The expected type of the removed object

validationException - If the value is not of type type

Returns:

null if not present else the object cast to type T

extractOptionalString

public static String extractOptionalString(Map<String,Object> map,
 String settingName,
 String scope,
 ValidationException validationException)

extractRequiredPositiveInteger

public static Integer extractRequiredPositiveInteger(Map<String,Object> map,
 String settingName,
 String scope,
 ValidationException validationException)

extractRequiredPositiveIntegerGreaterThanOrEqualToMin

public static Integer extractRequiredPositiveIntegerGreaterThanOrEqualToMin(Map<String,Object> map,
 String settingName,
 int minValue,
 String scope,
 ValidationException validationException)

extractRequiredPositiveIntegerLessThanOrEqualToMax

public static Integer extractRequiredPositiveIntegerLessThanOrEqualToMax(Map<String,Object> map,
 String settingName,
 int maxValue,
 String scope,
 ValidationException validationException)

extractOptionalList

public static <T> List<T> extractOptionalList(Map<String,Object> map,
 String settingName,
 Class<T> type,
 ValidationException validationException)

extractOptionalEnum

public static <E extends Enum<E>> E extractOptionalEnum(Map<String,Object> map,
 String settingName,
 String scope,
 InferenceUtils.EnumConstructor<E> constructor,
 EnumSet<E> validValues,
 ValidationException validationException)

mustBeNonEmptyString

public static String mustBeNonEmptyString(String settingName,
 String scope)

invalidValue

public static String invalidValue(String settingName,
 String scope,
 String invalidType,
 String[] requiredValues)

invalidTypeErrorMsg

public static String invalidTypeErrorMsg(String settingName,
 Object foundObject,
 String expectedType)

missingSettingErrorMsg

public static String missingSettingErrorMsg(String settingName,
 String scope)

mustBeGreaterThanOrEqualNumberErrorMessage

public static String mustBeGreaterThanOrEqualNumberErrorMessage(String settingName,
 String scope,
 double value,
 double minValue)

mustBeLessThanOrEqualNumberErrorMessage

public static String mustBeLessThanOrEqualNumberErrorMessage(String settingName,
 String scope,
 double value,
 double maxValue)

mustBeAPositiveIntegerErrorMessage

public static String mustBeAPositiveIntegerErrorMessage(String settingName,
 String scope,
 int value)