models

Documentation

Overview

models describes the data types that will be used when storing export data in Redis.

Index

• type StoredObject
  • func (o *StoredObject) FromContract(c contracts.StoredObject)
  • func (o StoredObject) MarshalJSON() ([]byte, error)
  • func (o StoredObject) ToContract() contracts.StoredObject
  • func (o *StoredObject) UnmarshalJSON(data []byte) error

Types

type StoredObject

type StoredObject struct {
	// ID uniquely identifies this StoredObject
	ID string `json:"id"`

	// AppServiceKey identifies the app to which this data belongs.
	AppServiceKey string `json:"appServiceKey"`

	// Payload is the data to be exported
	Payload []byte `json:"payload"`

	// RetryCount is how many times this has tried to be exported
	RetryCount int `json:"retryCount"`

	// PipelinePosition is where to pickup in the pipeline
	PipelinePosition int `json:"pipelinePosition"`

	// Version is a hash of the functions to know if the pipeline has changed.
	Version string `json:"version"`

	// CorrelationID is an identifier provided by EdgeX to track this record as it moves
	CorrelationID string `json:"correlationID"`

	// EventID is used to identify an EdgeX event from the core services and mark it as pushed.
	EventID string `json:"eventID"`

	// EventChecksum is used to identify CBOR encoded data from the core services and mark it as pushed.
	EventChecksum string `json:"eventChecksum"`
}

StoredObject is the atomic and most abstract description of what is collected by the export store system.

func (*StoredObject) FromContract

func (o *StoredObject) FromContract(c contracts.StoredObject)

FromContract builds a model out of the supplied contract.

func (StoredObject) MarshalJSON

func (o StoredObject) MarshalJSON() ([]byte, error)

MarshalJSON returns the object as a JSON encoded byte array.

func (StoredObject) ToContract

func (o StoredObject) ToContract() contracts.StoredObject

ToContract builds a contract out of the supplied model.

func (*StoredObject) UnmarshalJSON

func (o *StoredObject) UnmarshalJSON(data []byte) error

UnmarshalJSON returns an object from JSON.