Documentation
¶
Overview ¶
contracts are implementation agnostic data storage models.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type StoredObject ¶
type StoredObject struct {
// ID uniquely identifies this StoredObject
ID string
// AppServiceKey identifies the app to which this data belongs.
AppServiceKey string
// Payload is the data to be exported
Payload []byte
// RetryCount is how many times this has tried to be exported
RetryCount int
// PipelinePosition is where to pickup in the pipeline
PipelinePosition int
// Version is a hash of the functions to know if the pipeline has changed.
Version string
// CorrelationID is an identifier provided by EdgeX to track this record as it moves
CorrelationID string
// EventID is used to identify an EdgeX event from the core services and mark it as pushed.
EventID string
// EventChecksum is used to identify CBOR encoded data from the core services and mark it as pushed.
EventChecksum string
}
StoredObject is the atomic and most abstract description of what is collected by the export store system.
func NewStoredObject ¶
func NewStoredObject(appServiceKey string, payload []byte, pipelinePosition int, version string) StoredObject
NewStoredObject creates a new instance of StoredObject and is the preferred way to create one.
func (*StoredObject) ValidateContract ¶
func (o *StoredObject) ValidateContract(IDRequired bool) error
ValidateContract ensures that the required fields are present on the object.
Click to show internal directories.
Click to hide internal directories.