settings

package

v2.42.0 Latest Latest Go to latest Published: Dec 10, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type ScopeSettingsParams struct {
	Merge string `url:"merge,omitempty"`
}

ScopeSettingsParams scope settings query parameter definition.

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

Settings is a settings client instance.

func New(api restapi.Connector) *Settings

New settings client constructor.

func (c *Settings) GetScopeSchema(scope string) (*json.RawMessage, error)

MARK: Schema GetScopeSchema get schema for the scope.

func (c *Settings) GetScopeSettings(scope string, opts ...filters.Option) (*json.RawMessage, error)

MARK: Settings GetScopeSettings get settings for the scope

func (c *Settings) GetSectionSchema(scope, section string) (*json.RawMessage, error)

GetSectionSchema get schema for the section

func (c *Settings) GetSectionSettings(scope, section string) (*json.RawMessage, error)

GetSectionSettings get settings for the section.

func (c *Settings) Status() (*response.ServiceStatus, error)

MARK: Status Status get settings microservice status.

func (c *Settings) UpdateScopeSettings(settings map[string]interface{}, scope string) error

UpdateScopeSettings update settings for a scope.

func (c *Settings) UpdateSectionSettings(scope, section string, settings map[string]interface{}) error

UpdateSectionSettings update settings for a scope and section combination.

func (c *Settings) VerifyRestartRequired(scope string, settings map[string]interface{}) (*map[string]interface{}, error)

MARK: Restart Required VerifyRestartRequired verify if restart is required for given settings scope.