export

README

EdgeX Foundry Export Services

Go implementation of EdgeX Export services.

export-client, export-distro and export-domain have been merged into one single repo. Additionaly, some classes from core-domain have been duplicated into this repo (needed for linking and data isolation of microservices).

Repo contains two microservices, export-client and export-distro.

Install and Deploy

To fetch the code and start the microservice execute:

go get github.com/edgexfoundry/export-go
cd $GOPATH/src/github.com/edgexfoundry/export-go
glide install
go run cmd/client/main.go

Community

• Chat: https://chat.edgexfoundry.org/home
• Mainling lists: https://lists.edgexfoundry.org/mailman/listinfo

License

Apache-2.0

Documentation

Index

• Constants
• type EncryptionDetails
• type Filter
• type NotifyUpdate
• type Registration
  • func (reg *Registration) Validate() bool

Constants

const (
	EncNone = "NONE"
	EncAes  = "AES"
)

Encryption types

const (
	CompNone = "NONE"
	CompGzip = "GZIP"
	CompZip  = "ZIP"
)

Compression algorithm types

const (
	FormatJSON        = "JSON"
	FormatXML         = "XML"
	FormatSerialized  = "SERIALIZED"
	FormatIoTCoreJSON = "IOTCORE_JSON"
	FormatAzureJSON   = "AZURE_JSON"
	FormatCSV         = "CSV"
)

Data format types

const (
	DestMQTT        = "MQTT_TOPIC"
	DestZMQ         = "ZMQ_TOPIC"
	DestIotCoreMQTT = "IOTCORE_TOPIC"
	DestAzureMQTT   = "AZURE_TOPIC"
	DestRest        = "REST_ENDPOINT"
)

Export destination types

const (
	NotifyUpdateAdd    = "add"
	NotifyUpdateUpdate = "update"
	NotifyUpdateDelete = "delete"
)

Types

type EncryptionDetails

type EncryptionDetails struct {
	Algo       string `bson:"encryptionAlgorithm,omitempty" json:"encryptionAlgorithm,omitempty"`
	Key        string `bson:"encryptionKey,omitempty" json:"encryptionKey,omitempty"`
	InitVector string `bson:"initializingVector,omitempty" json:"initializingVector,omitempty"`
}

EncryptionDetails - Provides details for encryption of export data per client request

type Filter

type Filter struct {
	DeviceIDs          []string `bson:"deviceIdentifiers,omitempty" json:"deviceIdentifiers,omitempty"`
	ValueDescriptorIDs []string `bson:"valueDescriptorIdentifiers,omitempty" json:"valueDescriptorIdentifiers,omitempty"`
}

Filter - Specifies the client filters on reading data

type NotifyUpdate

type NotifyUpdate struct {
	Name      string `json:"name"`
	Operation string `json:"operation"`
}

type Registration

type Registration struct {
	ID          bson.ObjectId      `bson:"_id,omitempty" json:"_id,omitempty"`
	Created     int64              `json:"created"`
	Modified    int64              `json:"modified"`
	Origin      int64              `json:"origin"`
	Name        string             `json:"name,omitempty"`
	Addressable models.Addressable `json:"addressable,omitempty"`
	Format      string             `json:"format,omitempty"`
	Filter      Filter             `json:"filter,omitempty"`
	Encryption  EncryptionDetails  `json:"encryption,omitempty"`
	Compression string             `json:"compression,omitempty"`
	Enable      bool               `json:"enable"`
	Destination string             `json:"destination,omitempty"`
}

Registration - Defines the registration details on the part of north side export clients

func (*Registration) Validate

func (reg *Registration) Validate() bool