flags

Documentation

Index

• Constants
• type Common
• type Default
  • func New() *Default
  • func NewWithUsage(additionalUsage string) *Default
  • func (d *Default) ConfigDirectory() string
  • func (d *Default) ConfigFileName() string
  • func (d *Default) ConfigProviderUrl() string
  • func (d *Default) Help()
  • func (d *Default) OverwriteConfig() bool
  • func (d *Default) Parse(arguments []string)
  • func (d *Default) Profile() string
  • func (d *Default) RegistryUrl() string
  • func (d *Default) UseRegistry() bool

Constants

const (
	DefaultConfigProvider = "consul.http://localhost:8500"

	// TODO: Remove these for release v2.0.0 when -registry is a bool
	UseRegistryNoUrlValue = "."
	DontUseRegistryValue  = "~"

	DefaultConfigFile = "configuration.toml"
)

Types

type Common

type Common interface {
	OverwriteConfig() bool
	UseRegistry() bool
	// TODO: Remove for release v2.0.0 once --registry=<url> no longer supported
	RegistryUrl() string
	ConfigProviderUrl() string
	Profile() string
	ConfigDirectory() string
	ConfigFileName() string
	Parse([]string)
	Help()
}

Common is an interface that defines AP for the common command-line flags used by most EdgeX services

type Default

type Default struct {
	FlagSet *flag.FlagSet
	// contains filtered or unexported fields
}

Default is the Default implementation of Common used by most EdgeX services

func New

func New() *Default

New returns a Default struct with an empty additional usage string.

func NewWithUsage

func NewWithUsage(additionalUsage string) *Default

NewWithUsage returns a Default struct.

func (*Default) ConfigDirectory

func (d *Default) ConfigDirectory() string

ConfigDirectory returns the directory where the config file(s) are located, if it was specified.

func (*Default) ConfigFileName

func (d *Default) ConfigFileName() string

ConfigFileName returns the name of the local configuration file

func (*Default) ConfigProviderUrl

func (d *Default) ConfigProviderUrl() string

ConfigProviderUrl returns the url for the Configuration Provider, if one was specified.

func (*Default) Help

func (d *Default) Help()

Help displays the usage help message and exit.

func (*Default) OverwriteConfig

func (d *Default) OverwriteConfig() bool

OverwriteConfig returns whether the local configuration should be pushed (overwrite) into the Configuration provider

func (*Default) Parse

func (d *Default) Parse(arguments []string)

Parse parses the passed in command-lie arguments looking to the default set of common flags

func (*Default) Profile

func (d *Default) Profile() string

Profile returns the profile name to use, if one was specified

func (*Default) RegistryUrl

func (d *Default) RegistryUrl() string

TODO: Remove this interface for release v2.0.0 RegistryUrl returns the url for the Registry Provider, if one was specified. For backwards compatibility with Fuji Device Service, registry is a string that can contain a provider URL.

func (*Default) UseRegistry

func (d *Default) UseRegistry() bool

UseRegistry returns whether the Registry should be used or not