settings

Documentation

Index

• Constants
• func ValidateSetting[T string | int64](value T, availableValues []T) bool
• type BaseClassSettings
  • func NewBaseClassSettings(cfg moduletools.ClassConfig) *BaseClassSettings
  • func NewBaseClassSettingsWithAltNames(cfg moduletools.ClassConfig, moduleName string, altNames []string, ...) *BaseClassSettings
  • func NewBaseClassSettingsWithCustomModel(cfg moduletools.ClassConfig, customModelParameterName string) *BaseClassSettings
  • func (s BaseClassSettings) GetNumber(in interface{}) (float32, error)
  • func (s BaseClassSettings) GetPropertyAsBool(name string, defaultValue bool) bool
  • func (s BaseClassSettings) GetPropertyAsInt64(name string, defaultValue *int64) *int64
  • func (s BaseClassSettings) GetPropertyAsString(name, defaultValue string) string
  • func (s BaseClassSettings) GetSettings() map[string]interface{}
  • func (s BaseClassSettings) Model() string
  • func (s BaseClassSettings) Properties() []string
  • func (s BaseClassSettings) PropertyIndexed(propName string) bool
  • func (s BaseClassSettings) Validate(class *models.Class) error
  • func (s BaseClassSettings) ValidateClassSettings() error
  • func (s BaseClassSettings) ValidateIndexState(class *models.Class) error
  • func (s BaseClassSettings) VectorizeClassName() bool
  • func (s BaseClassSettings) VectorizePropertyName(propName string) bool
• type PropertyValuesHelper
  • func NewPropertyValuesHelper(moduleName string) PropertyValuesHelper
  • func NewPropertyValuesHelperWithAltNames(moduleName string, altNames []string) PropertyValuesHelper

Constants

const (
	DefaultPropertyIndexed       = true
	DefaultVectorizeClassName    = true
	DefaultVectorizePropertyName = false
)

Functions

func ValidateSetting

func ValidateSetting[T string | int64](value T, availableValues []T) bool

Types

type BaseClassSettings

type BaseClassSettings struct {
	// contains filtered or unexported fields
}

func NewBaseClassSettings

func NewBaseClassSettings(cfg moduletools.ClassConfig) *BaseClassSettings

func NewBaseClassSettingsWithAltNames

func NewBaseClassSettingsWithAltNames(cfg moduletools.ClassConfig,
	moduleName string, altNames []string, customModelParameterName []string,
) *BaseClassSettings

func NewBaseClassSettingsWithCustomModel

func NewBaseClassSettingsWithCustomModel(cfg moduletools.ClassConfig, customModelParameterName string) *BaseClassSettings

func (BaseClassSettings) GetNumber

func (s BaseClassSettings) GetNumber(in interface{}) (float32, error)

func (BaseClassSettings) GetPropertyAsBool

func (s BaseClassSettings) GetPropertyAsBool(name string, defaultValue bool) bool

func (BaseClassSettings) GetPropertyAsInt64

func (s BaseClassSettings) GetPropertyAsInt64(name string, defaultValue *int64) *int64

func (BaseClassSettings) GetPropertyAsString

func (s BaseClassSettings) GetPropertyAsString(name, defaultValue string) string

func (BaseClassSettings) GetSettings

func (s BaseClassSettings) GetSettings() map[string]interface{}

func (BaseClassSettings) Model

func (s BaseClassSettings) Model() string

func (BaseClassSettings) Properties

func (s BaseClassSettings) Properties() []string

func (BaseClassSettings) PropertyIndexed

func (s BaseClassSettings) PropertyIndexed(propName string) bool

func (BaseClassSettings) Validate

func (s BaseClassSettings) Validate(class *models.Class) error

func (BaseClassSettings) ValidateClassSettings

func (s BaseClassSettings) ValidateClassSettings() error

func (BaseClassSettings) ValidateIndexState

func (s BaseClassSettings) ValidateIndexState(class *models.Class) error

func (BaseClassSettings) VectorizeClassName

func (s BaseClassSettings) VectorizeClassName() bool

func (BaseClassSettings) VectorizePropertyName

func (s BaseClassSettings) VectorizePropertyName(propName string) bool

type PropertyValuesHelper

type PropertyValuesHelper interface {
	GetPropertyAsInt(cfg moduletools.ClassConfig, name string, defaultValue *int) *int
	GetPropertyAsIntWithNotExists(cfg moduletools.ClassConfig, name string, defaultValue, notExistsValue *int) *int
	GetPropertyAsInt64(cfg moduletools.ClassConfig, name string, defaultValue *int64) *int64
	GetPropertyAsInt64WithNotExists(cfg moduletools.ClassConfig, name string, defaultValue, notExistsValue *int64) *int64
	GetPropertyAsFloat64(cfg moduletools.ClassConfig, name string, defaultValue *float64) *float64
	GetPropertyAsFloat64WithNotExists(cfg moduletools.ClassConfig, name string, defaultValue, notExistsValue *float64) *float64
	GetPropertyAsString(cfg moduletools.ClassConfig, name, defaultValue string) string
	GetPropertyAsStringWithNotExists(cfg moduletools.ClassConfig, name, defaultValue, notExistsValue string) string
	GetPropertyAsBool(cfg moduletools.ClassConfig, name string, defaultValue bool) bool
	GetPropertyAsBoolWithNotExists(cfg moduletools.ClassConfig, name string, defaultValue, notExistsValue bool) bool
	GetNumber(in interface{}) (float32, error)
}

func NewPropertyValuesHelper

func NewPropertyValuesHelper(moduleName string) PropertyValuesHelper

func NewPropertyValuesHelperWithAltNames

func NewPropertyValuesHelperWithAltNames(moduleName string, altNames []string) PropertyValuesHelper