c8ysession

Documentation

Index

• func ClearEnvironmentVariables(shell utilities.ShellType)
• func ClearProcessEnvironment()
• func FormatHost(host string) string
• func GetSessionEnvKeys() []string
• func GetVariablesFromSession(session *CumulocitySession, client *c8y.Client, setPassword bool) map[string]interface{}
• func IsSessionFilePath(path string) bool
• func PrintSessionInfo(w io.Writer, client *c8y.Client, cfg *config.Config, session CumulocitySession)
• func PrintSessionInfoAsJSON(w io.Writer, client *c8y.Client, cfg *config.Config, session CumulocitySession) error
• func ShowClientEnvironmentVariables(cfg *config.Config, c8yclient *c8y.Client, shell utilities.ShellType)
• func ShowSessionEnvironmentVariables(session *CumulocitySession, cfg *config.Config, c8yclient *c8y.Client, ...)
• func WriteOutput(w io.Writer, client *c8y.Client, cfg *config.Config, ...) error
• type CumulocitySession
  • func (s CumulocitySession) GetDomain() string
  • func (s CumulocitySession) GetHost() string
  • func (s CumulocitySession) GetPassword() string
  • func (s CumulocitySession) GetSessionPassphrase() string
  • func (s *CumulocitySession) SetHost(host string)
  • func (s *CumulocitySession) SetPassword(password string)
  • func (s *CumulocitySession) SetToken(token string)
• type CumulocitySessions

Functions

func ClearEnvironmentVariables

func ClearEnvironmentVariables(shell utilities.ShellType)

func ClearProcessEnvironment

func ClearProcessEnvironment()

func FormatHost

func FormatHost(host string) string

func GetSessionEnvKeys

func GetSessionEnvKeys() []string

func GetVariablesFromSession

func GetVariablesFromSession(session *CumulocitySession, client *c8y.Client, setPassword bool) map[string]interface{}

GetVariablesFromSession gets all the environment variables associated with the current session

func IsSessionFilePath

func IsSessionFilePath(path string) bool

func PrintSessionInfo

func PrintSessionInfo(w io.Writer, client *c8y.Client, cfg *config.Config, session CumulocitySession)

PrintSessionInfo print out the session information to writer (i.e. console or file)

func PrintSessionInfoAsJSON

func PrintSessionInfoAsJSON(w io.Writer, client *c8y.Client, cfg *config.Config, session CumulocitySession) error

func ShowClientEnvironmentVariables

func ShowClientEnvironmentVariables(cfg *config.Config, c8yclient *c8y.Client, shell utilities.ShellType)

func ShowSessionEnvironmentVariables

func ShowSessionEnvironmentVariables(session *CumulocitySession, cfg *config.Config, c8yclient *c8y.Client, shell utilities.ShellType)

func WriteOutput

func WriteOutput(w io.Writer, client *c8y.Client, cfg *config.Config, session *CumulocitySession, format string) error

Types

type CumulocitySession

type CumulocitySession struct {
	Schema string `json:"$schema,omitempty"`

	// ID          string `json:"id"`
	Host            string `json:"host"`
	Tenant          string `json:"tenant"`
	Version         string `json:"version"`
	Username        string `json:"username"`
	Password        string `json:"password"`
	TOTP            string `json:"totp"`
	Token           string `json:"token"`
	Description     string `json:"description"`
	UseTenantPrefix bool   `json:"useTenantPrefix"`

	Settings *config.CommandSettings `json:"settings,omitempty"`

	MicroserviceAliases map[string]string `json:"microserviceAliases,omitempty"`

	Index     int    `json:"-"`
	Path      string `json:"-"`
	Extension string `json:"-"`
	Name      string `json:"-"`

	// How to identify the session
	SessionUri string `json:"sessionUri"`

	Logger *logger.Logger `json:"-"`
	Config *config.Config `json:"-"`
}

CumulocitySession contains all settings required to communicate with a Cumulocity service

func (CumulocitySession) GetDomain

func (s CumulocitySession) GetDomain() string

GetDomain gets the custom Cumulocity domain for cases where it differs from the Host

func (CumulocitySession) GetHost

func (s CumulocitySession) GetHost() string

func (CumulocitySession) GetPassword

func (s CumulocitySession) GetPassword() string

func (CumulocitySession) GetSessionPassphrase

func (s CumulocitySession) GetSessionPassphrase() string

func (*CumulocitySession) SetHost

func (s *CumulocitySession) SetHost(host string)

func (*CumulocitySession) SetPassword

func (s *CumulocitySession) SetPassword(password string)

func (*CumulocitySession) SetToken

func (s *CumulocitySession) SetToken(token string)

type CumulocitySessions

type CumulocitySessions struct {
	Sessions []CumulocitySession `json:"sessions"`
}