Versions in this module Expand all Collapse all v0 v0.25.2 Jun 5, 2025 Changes in this version + const ForSystemTenant + const ForVirtualCluster + const MaxSettings + const VersionSettingValueType + var ErrIntOverflowEncoding = fmt.Errorf("proto: integer overflow") + var ErrInvalidLengthEncoding = fmt.Errorf("proto: negative length found during unmarshaling") + var ErrUnexpectedEndOfGroupEncoding = fmt.Errorf("proto: unexpected end of group") + var ReadableTypes = map[string]string + var TestOpaque interface{} = testOpaqueType + func EncodeBool(b bool) string + func EncodeDuration(d time.Duration) string + func EncodeFloat(f float64) string + func EncodeInt(i int64) string + func EncodeProtobuf(p protoutil.Message) string + func IsIgnoringAllUpdates() bool + func LookupForDisplay(name SettingName, forSystemTenant, canViewSensitive bool) (Setting, bool, NameStatus) + func LookupForLocalAccess(name SettingName, forSystemTenant bool) (NonMaskedSetting, bool, NameStatus) + func NameToKey(name SettingName) (key InternalKey, found bool, nameStatus NameStatus) + func NumRegisteredSettings() int + func RedactedValue(key InternalKey, values *Values, forSystemTenant bool) string + func RegisterVersionSetting(class Class, key InternalKey, desc string, setting *VersionSetting, ...) + func SettingPreviouslyHadApplicationClass(key InternalKey) bool + func TestingIsReportable(s Setting) bool + func TestingIsSensitive(s Setting) bool + func TestingListPrevAppSettings() map[InternalKey]struct + func TestingSaveRegistry() func() + type AnyEnumSetting interface + GetAvailableValuesAsHint func() string + ParseEnum func(raw string) (int64, bool) + type BoolSetting struct + func RegisterBoolSetting(class Class, key InternalKey, desc string, defaultValue bool, ...) *BoolSetting + func (*BoolSetting) Typ() string + func (b *BoolSetting) DecodeToString(encoded string) (string, error) + func (b *BoolSetting) DecodeValue(encoded string) (bool, error) + func (b *BoolSetting) Default() bool + func (b *BoolSetting) DefaultString() string + func (b *BoolSetting) Encoded(sv *Values) string + func (b *BoolSetting) EncodedDefault() string + func (b *BoolSetting) Get(sv *Values) bool + func (b *BoolSetting) Override(ctx context.Context, sv *Values, v bool) + func (b *BoolSetting) String(sv *Values) string + func (b *BoolSetting) Validate(sv *Values, v bool) error + func (c *BoolSetting) ErrorHint() (bool, string) + func (c *BoolSetting) IsUnsafe() bool + func (c *BoolSetting) SetOnChange(sv *Values, fn func(ctx context.Context)) + func (c *BoolSetting) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (c BoolSetting) Class() Class + func (c BoolSetting) Description() string + func (c BoolSetting) InternalKey() InternalKey + func (c BoolSetting) Name() SettingName + func (c BoolSetting) Visibility() Visibility + type ByteSizeSetting struct + func RegisterByteSizeSetting(class Class, key InternalKey, desc string, defaultValue int64, ...) *ByteSizeSetting + func (*ByteSizeSetting) Typ() string + func (b *ByteSizeSetting) DecodeToString(encoded string) (string, error) + func (b *ByteSizeSetting) DefaultString() string + func (b *ByteSizeSetting) String(sv *Values) string + func (c *ByteSizeSetting) ErrorHint() (bool, string) + func (c *ByteSizeSetting) IsUnsafe() bool + func (c *ByteSizeSetting) SetOnChange(sv *Values, fn func(ctx context.Context)) + func (c *ByteSizeSetting) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (c ByteSizeSetting) Class() Class + func (c ByteSizeSetting) Description() string + func (c ByteSizeSetting) InternalKey() InternalKey + func (c ByteSizeSetting) Name() SettingName + func (c ByteSizeSetting) Visibility() Visibility + type Class int8 + const ApplicationLevel + const SystemOnly + const SystemVisible + type ClusterVersionImpl interface + Encode func() []byte + type DurationSetting struct + func RegisterDurationSetting(class Class, key InternalKey, desc string, defaultValue time.Duration, ...) *DurationSetting + func (*DurationSetting) Typ() string + func (c *DurationSetting) ErrorHint() (bool, string) + func (c *DurationSetting) IsUnsafe() bool + func (c *DurationSetting) SetOnChange(sv *Values, fn func(ctx context.Context)) + func (c *DurationSetting) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (c DurationSetting) Class() Class + func (c DurationSetting) Description() string + func (c DurationSetting) InternalKey() InternalKey + func (c DurationSetting) Name() SettingName + func (c DurationSetting) Visibility() Visibility + func (d *DurationSetting) DecodeToString(encoded string) (string, error) + func (d *DurationSetting) DecodeValue(encoded string) (time.Duration, error) + func (d *DurationSetting) Default() time.Duration + func (d *DurationSetting) DefaultString() string + func (d *DurationSetting) Encoded(sv *Values) string + func (d *DurationSetting) EncodedDefault() string + func (d *DurationSetting) Get(sv *Values) time.Duration + func (d *DurationSetting) Override(ctx context.Context, sv *Values, v time.Duration) + func (d *DurationSetting) String(sv *Values) string + func (d *DurationSetting) Validate(v time.Duration) error + type DurationSettingWithExplicitUnit struct + func RegisterDurationSettingWithExplicitUnit(class Class, key InternalKey, desc string, defaultValue time.Duration, ...) *DurationSettingWithExplicitUnit + func (c *DurationSettingWithExplicitUnit) IsUnsafe() bool + func (c *DurationSettingWithExplicitUnit) SetOnChange(sv *Values, fn func(ctx context.Context)) + func (c *DurationSettingWithExplicitUnit) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (c DurationSettingWithExplicitUnit) Class() Class + func (c DurationSettingWithExplicitUnit) Description() string + func (c DurationSettingWithExplicitUnit) InternalKey() InternalKey + func (c DurationSettingWithExplicitUnit) Name() SettingName + func (c DurationSettingWithExplicitUnit) Visibility() Visibility + func (d *DurationSettingWithExplicitUnit) ErrorHint() (bool, string) + type EncodedValue struct + Type string + Value string + func (*EncodedValue) Descriptor() ([]byte, []int) + func (*EncodedValue) ProtoMessage() + func (m *EncodedValue) Marshal() (dAtA []byte, err error) + func (m *EncodedValue) MarshalTo(dAtA []byte) (int, error) + func (m *EncodedValue) MarshalToSizedBuffer(dAtA []byte) (int, error) + func (m *EncodedValue) Reset() + func (m *EncodedValue) Size() (n int) + func (m *EncodedValue) Unmarshal(dAtA []byte) error + func (m *EncodedValue) XXX_DiscardUnknown() + func (m *EncodedValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) + func (m *EncodedValue) XXX_Merge(src proto.Message) + func (m *EncodedValue) XXX_Size() int + func (m *EncodedValue) XXX_Unmarshal(b []byte) error + func (this *EncodedValue) Equal(that interface{}) bool + func (v EncodedValue) SafeFormat(s interfaces.SafePrinter, verb rune) + func (v EncodedValue) String() string + type EnumSetting struct + func RegisterEnumSetting[T constraints.Integer](class Class, key InternalKey, desc string, defaultValue string, ...) *EnumSetting[T] + func (c *EnumSetting) ErrorHint() (bool, string) + func (c *EnumSetting) IsUnsafe() bool + func (c *EnumSetting) SetOnChange(sv *Values, fn func(ctx context.Context)) + func (c *EnumSetting) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (c EnumSetting) Class() Class + func (c EnumSetting) Description() string + func (c EnumSetting) InternalKey() InternalKey + func (c EnumSetting) Name() SettingName + func (c EnumSetting) Visibility() Visibility + func (e *EnumSetting[T]) DecodeToString(encoded string) (string, error) + func (e *EnumSetting[T]) DefaultString() string + func (e *EnumSetting[T]) Encoded(sv *Values) string + func (e *EnumSetting[T]) EncodedDefault() string + func (e *EnumSetting[T]) Get(sv *Values) T + func (e *EnumSetting[T]) GetAvailableValues() []string + func (e *EnumSetting[T]) GetAvailableValuesAsHint() string + func (e *EnumSetting[T]) Override(ctx context.Context, sv *Values, v T) + func (e *EnumSetting[T]) ParseEnum(raw string) (int64, bool) + func (e *EnumSetting[T]) String(sv *Values) string + func (e *EnumSetting[T]) Typ() string + type FloatSetting struct + func RegisterFloatSetting(class Class, key InternalKey, desc string, defaultValue float64, ...) *FloatSetting + func (*FloatSetting) Typ() string + func (c *FloatSetting) ErrorHint() (bool, string) + func (c *FloatSetting) IsUnsafe() bool + func (c *FloatSetting) SetOnChange(sv *Values, fn func(ctx context.Context)) + func (c *FloatSetting) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (c FloatSetting) Class() Class + func (c FloatSetting) Description() string + func (c FloatSetting) InternalKey() InternalKey + func (c FloatSetting) Name() SettingName + func (c FloatSetting) Visibility() Visibility + func (f *FloatSetting) DecodeToString(encoded string) (string, error) + func (f *FloatSetting) DecodeValue(encoded string) (float64, error) + func (f *FloatSetting) Default() float64 + func (f *FloatSetting) DefaultString() string + func (f *FloatSetting) Encoded(sv *Values) string + func (f *FloatSetting) EncodedDefault() string + func (f *FloatSetting) Get(sv *Values) float64 + func (f *FloatSetting) Override(ctx context.Context, sv *Values, v float64) + func (f *FloatSetting) String(sv *Values) string + func (f *FloatSetting) Validate(v float64) error + type IntSetting struct + func RegisterIntSetting(class Class, key InternalKey, desc string, defaultValue int64, ...) *IntSetting + func (*IntSetting) Typ() string + func (c *IntSetting) ErrorHint() (bool, string) + func (c *IntSetting) IsUnsafe() bool + func (c *IntSetting) SetOnChange(sv *Values, fn func(ctx context.Context)) + func (c *IntSetting) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (c IntSetting) Class() Class + func (c IntSetting) Description() string + func (c IntSetting) InternalKey() InternalKey + func (c IntSetting) Name() SettingName + func (c IntSetting) Visibility() Visibility + func (i *IntSetting) DecodeNumericValue(value string) (int64, error) + func (i *IntSetting) DecodeToString(encoded string) (string, error) + func (i *IntSetting) Default() int64 + func (i *IntSetting) DefaultString() string + func (i *IntSetting) Encoded(sv *Values) string + func (i *IntSetting) EncodedDefault() string + func (i *IntSetting) Get(sv *Values) int64 + func (i *IntSetting) Override(ctx context.Context, sv *Values, v int64) + func (i *IntSetting) String(sv *Values) string + func (i *IntSetting) Validate(v int64) error + type InternalKey string + func ConsoleKeys() (res []InternalKey) + func Keys(forSystemTenant bool) (res []InternalKey) + func SystemVisibleKeys() []InternalKey + func (InternalKey) SafeValue() + type MaskedSetting struct + func (s *MaskedSetting) Class() Class + func (s *MaskedSetting) DefaultString() string + func (s *MaskedSetting) Description() string + func (s *MaskedSetting) InternalKey() InternalKey + func (s *MaskedSetting) IsUnsafe() bool + func (s *MaskedSetting) Name() SettingName + func (s *MaskedSetting) String(sv *Values) string + func (s *MaskedSetting) Typ() string + func (s *MaskedSetting) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (s *MaskedSetting) Visibility() Visibility + type NameStatus bool + const NameActive + const NameRetired + type NonMaskedSetting interface + DecodeToString func(encoded string) (repr string, err error) + Encoded func(sv *Values) string + EncodedDefault func() string + ErrorHint func() (bool, string) + SetOnChange func(sv *Values, fn func(ctx context.Context)) + func LookupForLocalAccessByKey(key InternalKey, forSystemTenant bool) (NonMaskedSetting, bool) + type NoopUpdater struct + func (u NoopUpdater) ResetRemaining(context.Context) + func (u NoopUpdater) Set(ctx context.Context, key InternalKey, value EncodedValue) error + func (u NoopUpdater) SetFromStorage(ctx context.Context, key InternalKey, value EncodedValue, origin ValueOrigin) error + func (u NoopUpdater) SetToDefault(ctx context.Context, key InternalKey) error + type ProtobufSetting struct + func RegisterProtobufSetting(class Class, key InternalKey, desc string, defaultValue protoutil.Message, ...) *ProtobufSetting + func (*ProtobufSetting) Typ() string + func (c *ProtobufSetting) ErrorHint() (bool, string) + func (c *ProtobufSetting) IsUnsafe() bool + func (c *ProtobufSetting) SetOnChange(sv *Values, fn func(ctx context.Context)) + func (c *ProtobufSetting) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (c ProtobufSetting) Class() Class + func (c ProtobufSetting) Description() string + func (c ProtobufSetting) InternalKey() InternalKey + func (c ProtobufSetting) Name() SettingName + func (c ProtobufSetting) Visibility() Visibility + func (s *ProtobufSetting) DecodeToString(encoded string) (string, error) + func (s *ProtobufSetting) DecodeValue(encoded string) (protoutil.Message, error) + func (s *ProtobufSetting) Default() protoutil.Message + func (s *ProtobufSetting) DefaultString() string + func (s *ProtobufSetting) Encoded(sv *Values) string + func (s *ProtobufSetting) EncodedDefault() string + func (s *ProtobufSetting) Get(sv *Values) protoutil.Message + func (s *ProtobufSetting) MarshalToJSON(p protoutil.Message) (string, error) + func (s *ProtobufSetting) Override(ctx context.Context, sv *Values, p protoutil.Message) + func (s *ProtobufSetting) String(sv *Values) string + func (s *ProtobufSetting) UnmarshalFromJSON(jsonEncoded string) (protoutil.Message, error) + func (s *ProtobufSetting) Validate(sv *Values, p protoutil.Message) error + type Setting interface + Class func() Class + DefaultString func() string + Description func() string + InternalKey func() InternalKey + IsUnsafe func() bool + Name func() SettingName + String func(sv *Values) string + Typ func() string + ValueOrigin func(ctx context.Context, sv *Values) ValueOrigin + Visibility func() Visibility + func LookupForDisplayByKey(key InternalKey, forSystemTenant, canViewSensitive bool) (Setting, bool) + func LookupForReportingByKey(key InternalKey, forSystemTenant bool) (Setting, bool) + type SettingName string + func (SettingName) SafeValue() + type SettingOption struct + var Fraction SettingOption = FloatInRange(0, 1) + var FractionUpperExclusive SettingOption = FloatInRangeUpperExclusive(0, 1) + var NonNegativeDuration SettingOption = WithValidateDuration(nonNegativeDurationInternal) + var NonNegativeFloat SettingOption = FloatWithMinimum(0) + var NonNegativeInt SettingOption = WithValidateInt(nonNegativeIntInternal) + var NonZeroFloat SettingOption = WithValidateFloat(func(v float64) error { ... }) + var PositiveDuration SettingOption = WithValidateDuration(func(v time.Duration) error { ... }) + var PositiveFloat SettingOption = WithValidateFloat(func(v float64) error { ... }) + var PositiveInt SettingOption = WithValidateInt(func(v int64) error { ... }) + var Retired SettingOption = SettingOption{} + var Sensitive SettingOption = SettingOption{} + var WithPublic SettingOption = WithVisibility(Public) + var WithUnsafe SettingOption = SettingOption{} + func ByteSizeWithMinimum(minVal int64) SettingOption + func DurationInRange(minVal, maxVal time.Duration) SettingOption + func DurationWithMinimum(minValue time.Duration) SettingOption + func DurationWithMinimumOrZeroDisable(minValue time.Duration) SettingOption + func FloatInRange(minVal, maxVal float64) SettingOption + func FloatInRangeUpperExclusive(minVal, maxVal float64) SettingOption + func FloatWithMinimum(minVal float64) SettingOption + func FloatWithMinimumOrZeroDisable(minVal float64) SettingOption + func IntInRange(minVal, maxVal int64) SettingOption + func IntInRangeOrZeroDisable(minVal, maxVal int64) SettingOption + func IntWithMinimum(minVal int64) SettingOption + func NonNegativeDurationWithMaximum(maxValue time.Duration) SettingOption + func NonNegativeFloatWithMaximum(maxValue float64) SettingOption + func NonNegativeIntWithMaximum(maxValue int64) SettingOption + func WithName(name SettingName) SettingOption + func WithReportable(reportable bool) SettingOption + func WithRetiredName(name SettingName) SettingOption + func WithValidateBool(fn func(*Values, bool) error) SettingOption + func WithValidateDuration(fn func(time.Duration) error) SettingOption + func WithValidateFloat(fn func(float64) error) SettingOption + func WithValidateInt(fn func(int64) error) SettingOption + func WithValidateProto(fn func(*Values, protoutil.Message) error) SettingOption + func WithValidateString(fn func(*Values, string) error) SettingOption + func WithVisibility(v Visibility) SettingOption + type StringSetting struct + func RegisterStringSetting(class Class, key InternalKey, desc string, defaultValue string, ...) *StringSetting + func (*StringSetting) Typ() string + func (c *StringSetting) ErrorHint() (bool, string) + func (c *StringSetting) IsUnsafe() bool + func (c *StringSetting) SetOnChange(sv *Values, fn func(ctx context.Context)) + func (c *StringSetting) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (c StringSetting) Class() Class + func (c StringSetting) Description() string + func (c StringSetting) InternalKey() InternalKey + func (c StringSetting) Name() SettingName + func (c StringSetting) Visibility() Visibility + func (s *StringSetting) DecodeToString(encoded string) (string, error) + func (s *StringSetting) Default() string + func (s *StringSetting) DefaultString() string + func (s *StringSetting) Encoded(sv *Values) string + func (s *StringSetting) EncodedDefault() string + func (s *StringSetting) Get(sv *Values) string + func (s *StringSetting) Override(ctx context.Context, sv *Values, v string) + func (s *StringSetting) String(sv *Values) string + func (s *StringSetting) Validate(sv *Values, v string) error + type Updater interface + ResetRemaining func(ctx context.Context) + Set func(ctx context.Context, key InternalKey, value EncodedValue) error + SetFromStorage func(ctx context.Context, key InternalKey, value EncodedValue, origin ValueOrigin) error + SetToDefault func(ctx context.Context, key InternalKey) error + func NewUpdater(sv *Values) Updater + type ValueOrigin uint32 + const OriginDefault + const OriginExplicitlySet + const OriginExternallySet + const OriginOverride + func (ValueOrigin) SafeValue() + func (v ValueOrigin) String() string + type Values struct + func (sv *Values) Init(ctx context.Context, opaque interface{}) + func (sv *Values) Opaque() interface{} + func (sv *Values) SpecializeForSystemInterface() + func (sv *Values) SpecializeForVirtualCluster() + func (sv *Values) SpecializedToVirtualCluster() bool + func (sv *Values) TestingCopyForServer(input *Values, newOpaque interface{}) + func (sv *Values) TestingCopyForVirtualCluster(input *Values) + type VersionSetting struct + func MakeVersionSetting(impl VersionSettingImpl) VersionSetting + func (*VersionSetting) Typ() string + func (c *VersionSetting) ErrorHint() (bool, string) + func (c *VersionSetting) IsUnsafe() bool + func (c *VersionSetting) SetOnChange(sv *Values, fn func(ctx context.Context)) + func (c *VersionSetting) ValueOrigin(ctx context.Context, sv *Values) ValueOrigin + func (c VersionSetting) Class() Class + func (c VersionSetting) Description() string + func (c VersionSetting) InternalKey() InternalKey + func (c VersionSetting) Name() SettingName + func (c VersionSetting) Visibility() Visibility + func (v *VersionSetting) DecodeToString(encoded string) (string, error) + func (v *VersionSetting) DefaultString() string + func (v *VersionSetting) Encoded(sv *Values) string + func (v *VersionSetting) EncodedDefault() string + func (v *VersionSetting) GetInternal(sv *Values) ClusterVersionImpl + func (v *VersionSetting) SetInternal(ctx context.Context, sv *Values, newVal ClusterVersionImpl) + func (v *VersionSetting) SettingsListDefault() string + func (v *VersionSetting) String(sv *Values) string + func (v *VersionSetting) Validate(ctx context.Context, sv *Values, oldV, newV []byte) error + type VersionSettingImpl interface + Decode func(val []byte) (ClusterVersionImpl, error) + SettingsListDefault func() string + ValidateBinaryVersions func(ctx context.Context, sv *Values, newV []byte) error + ValidateVersionUpgrade func(ctx context.Context, sv *Values, oldV, newV []byte) error + type Visibility int8 + const Public + const Reserved
Go to main page