common

Documentation

Index

• Constants
• type BindingInfo
• type ConfigurationStruct
  • func (c *ConfigurationStruct) EmptyWritablePtr() interface{}
  • func (c *ConfigurationStruct) GetBootstrap() interfaces.BootstrapConfiguration
  • func (c *ConfigurationStruct) GetLogLevel() string
  • func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo
  • func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool
  • func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool
• type Credentials
• type EdgeXClients
• type InsecureSecrets
• type InsecureSecretsInfo
• type PipelineFunction
• type PipelineInfo
• type ServiceInfo
• type StoreAndForwardInfo
• type WritableInfo

Constants

const (
	CoreCommandClientName   = "Command"
	CoreDataClientName      = "CoreData"
	NotificationsClientName = "Notifications"
)

Types

type BindingInfo

type BindingInfo struct {
	// Type of trigger to start pipeline
	//
	// example: messagebus
	// required: true
	// enum: messagebus,http
	Type           string
	SubscribeTopic string
	PublishTopic   string
}

BindingInfo contains Metadata associated with each binding

type ConfigurationStruct

type ConfigurationStruct struct {
	// Writable
	Writable WritableInfo
	// Logging
	Logging bootstrapConfig.LoggingInfo
	// Registry
	Registry bootstrapConfig.RegistryInfo
	// Service
	Service ServiceInfo
	// MessageBus
	MessageBus types.MessageBusConfig
	// Binding
	Binding BindingInfo
	// ApplicationSettings
	ApplicationSettings map[string]string
	// Clients
	Clients map[string]bootstrapConfig.ClientInfo
	// Database
	Database db.DatabaseInfo
	// SecretStore
	SecretStore bootstrapConfig.SecretStoreInfo
	// SecretStoreExclusive
	SecretStoreExclusive bootstrapConfig.SecretStoreInfo
	// Startup
	Startup bootstrapConfig.StartupInfo
}

ConfigurationStruct swagger:model ConfigurationStruct

func (*ConfigurationStruct) EmptyWritablePtr

func (c *ConfigurationStruct) EmptyWritablePtr() interface{}

EmptyWritablePtr returns a pointer to an empty WritableInfo struct. It is used by the bootstrap to provide the appropriate structure for Config Client's WatchForChanges().

func (*ConfigurationStruct) GetBootstrap

func (c *ConfigurationStruct) GetBootstrap() interfaces.BootstrapConfiguration

GetBootstrap returns the configuration elements required by the bootstrap.

func (*ConfigurationStruct) GetLogLevel

func (c *ConfigurationStruct) GetLogLevel() string

GetLogLevel returns log level from the configuration

func (*ConfigurationStruct) GetRegistryInfo

func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo

GetRegistryInfo returns the RegistryInfo section from the configuration

func (*ConfigurationStruct) UpdateFromRaw

func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool

UpdateFromRaw converts configuration received from the registry to a service-specific configuration struct which is then used to overwrite the service's existing configuration struct.

func (*ConfigurationStruct) UpdateWritableFromRaw

func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool

UpdateWritableFromRaw updates the Writeable section of configuration from raw update received from Configuration Provider.

type Credentials

type Credentials struct {
	Username string
	Password string
}

Credentials encapsulates username-password attributes.

type EdgeXClients

type EdgeXClients struct {
	LoggingClient         logger.LoggingClient
	EventClient           coredata.EventClient
	CommandClient         command.CommandClient
	ValueDescriptorClient coredata.ValueDescriptorClient
	NotificationsClient   notifications.NotificationsClient
}

type InsecureSecrets

type InsecureSecrets map[string]InsecureSecretsInfo

InsecureSecrets is used to hold the secrets stored in the configuration

type InsecureSecretsInfo

type InsecureSecretsInfo struct {
	Path    string
	Secrets map[string]string
}

InsecureSecretsInfo encapsulates info used to retrieve insecure secrets

type PipelineFunction

type PipelineFunction struct {
	// Name	string
	Parameters  map[string]string
	Addressable models.Addressable
}

type PipelineInfo

type PipelineInfo struct {
	ExecutionOrder           string
	UseTargetTypeOfByteArray bool
	Functions                map[string]PipelineFunction
}

type ServiceInfo

type ServiceInfo struct {
	BootTimeout   string
	CheckInterval string
	ClientMonitor string
	Host          string
	HTTPSCert     string
	HTTPSKey      string
	Port          int
	Protocol      string
	StartupMsg    string
	ReadMaxLimit  int
	Timeout       string
}

ServiceInfo is used to hold and configure various settings related to the hosting of this service

type StoreAndForwardInfo

type StoreAndForwardInfo struct {
	Enabled       bool
	RetryInterval string
	MaxRetryCount int
}

type WritableInfo

type WritableInfo struct {
	// Set level of logging to report
	//
	// example: TRACE
	// required: true
	// enum: TRACE,DEBUG,INFO,WARN,ERROR
	LogLevel        string
	Pipeline        PipelineInfo
	StoreAndForward StoreAndForwardInfo
	InsecureSecrets InsecureSecrets
}

WritableInfo is used to hold configuration information that is considered "live" or can be changed on the fly without a restart of the service.