settings

Documentation

Overview

Package settings contains global settings for starting a Config Server.

Index

• func GetGlobalConfigLoc(ctx context.Context) *cfgcommonpb.GitilesLocation
• func WithGlobalConfigLoc(ctx context.Context, location *cfgcommonpb.GitilesLocation) context.Context
• type GlobalConfigLoc
  • func (l *GlobalConfigLoc) MarshalText() (text []byte, err error)
  • func (l *GlobalConfigLoc) RegisterFlags(fs *flag.FlagSet)
  • func (l *GlobalConfigLoc) UnmarshalText(text []byte) error
  • func (l *GlobalConfigLoc) Validate() error

Functions

func GetGlobalConfigLoc

func GetGlobalConfigLoc(ctx context.Context) *cfgcommonpb.GitilesLocation

GetGlobalConfigLoc returns a GitilesLocation installed in the context.

func WithGlobalConfigLoc

func WithGlobalConfigLoc(ctx context.Context, location *cfgcommonpb.GitilesLocation) context.Context

WithGlobalConfigLoc returns a context with the given config location.

Types

type GlobalConfigLoc

type GlobalConfigLoc struct {
	*cfgcommonpb.GitilesLocation
}

GlobalConfigLoc is a setting to indicate the global config root location.

func (*GlobalConfigLoc) MarshalText

func (l *GlobalConfigLoc) MarshalText() (text []byte, err error)

MarshalText marshal itself into a textual form. Implements encoding.TextMarshaler.

func (*GlobalConfigLoc) RegisterFlags

func (l *GlobalConfigLoc) RegisterFlags(fs *flag.FlagSet)

RegisterFlags registers "-global-config-location" into command line flag set.

func (*GlobalConfigLoc) UnmarshalText

func (l *GlobalConfigLoc) UnmarshalText(text []byte) error

UnmarshalText unmarshal a textual representation of GlobalConfigLoc. Implements encoding.TextUnmarshaler.

func (*GlobalConfigLoc) Validate

func (l *GlobalConfigLoc) Validate() error

Validate validates the GlobalConfigLoc