settings

Documentation

Index

• type Params
• type Settings
  • func New(api restapi.Connector) *Settings
  • func (store *Settings) RestartRequired(settings *json.RawMessage, scope string) (*json.RawMessage, error)
  • func (store *Settings) ScopeSchema(scope string) (*json.RawMessage, error)
  • func (store *Settings) ScopeSectionSettings(scope, section string) (*json.RawMessage, error)
  • func (store *Settings) ScopeSettings(scope, merge string) (*json.RawMessage, error)
  • func (store *Settings) SectionSchema(scope, section string) (*json.RawMessage, error)
  • func (store *Settings) UpdateScopeSectionSettings(settings *json.RawMessage, scope, section string) error
  • func (store *Settings) UpdateScopeSettings(settings *json.RawMessage, scope string) error

Types

type Params

type Params struct {
	Merge string `json:"merge,omitempty"`
}

Params query parameter definition

type Settings

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

Settings is a settings client instance.

func New

func New(api restapi.Connector) *Settings

New creates a new settings client instance, using the argument SDK API client.

func (*Settings) RestartRequired

func (store *Settings) RestartRequired(settings *json.RawMessage, scope string) (*json.RawMessage, error)

RestartRequired get restart required information for given settings and scope

func (*Settings) ScopeSchema

func (store *Settings) ScopeSchema(scope string) (*json.RawMessage, error)

ScopeSchema get schema for the scope

func (*Settings) ScopeSectionSettings

func (store *Settings) ScopeSectionSettings(scope, section string) (*json.RawMessage, error)

ScopeSectionSettings get settings for the scope

func (*Settings) ScopeSettings

func (store *Settings) ScopeSettings(scope, merge string) (*json.RawMessage, error)

ScopeSettings get settings for the scope

func (*Settings) SectionSchema

func (store *Settings) SectionSchema(scope, section string) (*json.RawMessage, error)

SectionSchema get schema for the section

func (*Settings) UpdateScopeSectionSettings

func (store *Settings) UpdateScopeSectionSettings(settings *json.RawMessage, scope, section string) error

UpdateScopeSectionSettings update settings for a scope and section combination

func (*Settings) UpdateScopeSettings

func (store *Settings) UpdateScopeSettings(settings *json.RawMessage, scope string) error

UpdateScopeSettings update settings for a scope.