v1alpha1

type ActualPropertyState struct {
	Name        string `json:"name"`
	GetURL      string `json:"getURL,omitempty"`
	ActualValue string `json:"actualValue"`
}

type AdminState string

type DeploymentTemplateSpec struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              appsv1.DeploymentSpec `json:"spec"`
}

type DesiredPropertyState struct {
	Name         string `json:"name"`
	PutURL       string `json:"putURL,omitempty"`
	DesiredValue string `json:"desiredValue"`
}

type Device struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DeviceSpec   `json:"spec,omitempty"`
	Status DeviceStatus `json:"status,omitempty"`
}

type DeviceCommand struct {
	Name               string              `json:"name"`
	IsHidden           bool                `json:"isHidden"`
	ReadWrite          string              `json:"readWrite"`
	ResourceOperations []ResourceOperation `json:"resourceOperations"`
}

type DeviceCondition struct {
	// Type of in place set condition.
	Type DeviceConditionType `json:"type,omitempty"`

	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status,omitempty"`

	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`

	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty"`
}

type DeviceConditionType string

type DeviceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Device `json:"items"`
}

type DeviceProfile struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DeviceProfileSpec   `json:"spec,omitempty"`
	Status DeviceProfileStatus `json:"status,omitempty"`
}

type DeviceProfileList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []DeviceProfile `json:"items"`
}

type DeviceProfileSpec struct {
	// NodePool specifies which nodePool the deviceProfile belongs to
	NodePool    string `json:"nodePool,omitempty"`
	Description string `json:"description,omitempty"`
	// Manufacturer of the device
	Manufacturer string `json:"manufacturer,omitempty"`
	// Model of the device
	Model string `json:"model,omitempty"`
	// Labels used to search for groups of profiles on EdgeX Foundry
	Labels          []string         `json:"labels,omitempty"`
	DeviceResources []DeviceResource `json:"deviceResources,omitempty"`
	DeviceCommands  []DeviceCommand  `json:"deviceCommands,omitempty"`
}

type DeviceProfileStatus struct {
	EdgeId string `json:"id,omitempty"`
	Synced bool   `json:"synced,omitempty"`
}

type DeviceResource struct {
	Description string             `json:"description"`
	Name        string             `json:"name"`
	Tag         string             `json:"tag,omitempty"`
	IsHidden    bool               `json:"isHidden"`
	Properties  ResourceProperties `json:"properties"`
	Attributes  map[string]string  `json:"attributes,omitempty"`
}

type DeviceService struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DeviceServiceSpec   `json:"spec,omitempty"`
	Status DeviceServiceStatus `json:"status,omitempty"`
}

type DeviceServiceCondition struct {
	// Type of in place set condition.
	Type DeviceServiceConditionType `json:"type,omitempty"`

	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status,omitempty"`

	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`

	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty"`
}

type DeviceServiceConditionType string

type DeviceServiceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []DeviceService `json:"items"`
}

type DeviceServiceSpec struct {
	BaseAddress string `json:"baseAddress"`
	// Information describing the device
	Description string `json:"description,omitempty"`
	// tags or other labels applied to the device service for search or other
	// identification needs on the EdgeX Foundry
	Labels []string `json:"labels,omitempty"`
	// Device Service Admin State
	AdminState AdminState `json:"adminState,omitempty"`
	// True means deviceService is managed by cloud, cloud can update the related fields
	// False means cloud can't update the fields
	Managed bool `json:"managed,omitempty"`
	// NodePool indicates which nodePool the deviceService comes from
	NodePool string `json:"nodePool,omitempty"`
}

type DeviceServiceStatus struct {
	// Synced indicates whether the device already exists on both OpenYurt and edge platform
	Synced bool `json:"synced,omitempty"`
	// the Id assigned by the edge platform
	EdgeId string `json:"edgeId,omitempty"`
	// time in milliseconds that the device last reported data to the core
	LastConnected int64 `json:"lastConnected,omitempty"`
	// time in milliseconds that the device last reported data to the core
	LastReported int64 `json:"lastReported,omitempty"`
	// Device Service Admin State
	AdminState AdminState `json:"adminState,omitempty"`
	// current deviceService state
	// +optional
	Conditions []DeviceServiceCondition `json:"conditions,omitempty"`
}

type DeviceSpec struct {
	// Information describing the device
	Description string `json:"description,omitempty"`
	// Admin state (locked/unlocked)
	AdminState AdminState `json:"adminState,omitempty"`
	// Operating state (enabled/disabled)
	OperatingState OperatingState `json:"operatingState,omitempty"`
	// A map of supported protocols for the given device
	Protocols map[string]ProtocolProperties `json:"protocols,omitempty"`
	// Other labels applied to the device to help with searching
	Labels []string `json:"labels,omitempty"`
	// Device service specific location (interface{} is an empty interface so
	// it can be anything)
	// TODO: location type in edgex is interface{}
	Location string `json:"location,omitempty"`
	// Associated Device Service - One per device
	Service string `json:"serviceName"`
	// Associated Device Profile - Describes the device
	Profile string `json:"profileName"`
	Notify  bool   `json:"notify"`
	// True means device is managed by cloud, cloud can update the related fields
	// False means cloud can't update the fields
	Managed bool `json:"managed,omitempty"`
	// NodePool indicates which nodePool the device comes from
	NodePool string `json:"nodePool,omitempty"`
	// TODO support the following field
	// A list of auto-generated events coming from the device
	// AutoEvents     []AutoEvent                   `json:"autoEvents"`
	// DeviceProperties represents the expected state of the device's properties
	DeviceProperties map[string]DesiredPropertyState `json:"deviceProperties,omitempty"`
}

type DeviceStatus struct {
	// Time (milliseconds) that the device last provided any feedback or
	// responded to any request
	LastConnected int64 `json:"lastConnected,omitempty"`
	// Time (milliseconds) that the device reported data to the core
	// microservice
	LastReported int64 `json:"lastReported,omitempty"`
	// Synced indicates whether the device already exists on both OpenYurt and edge platform
	Synced bool `json:"synced,omitempty"`
	// it represents the actual state of the device's properties
	DeviceProperties map[string]ActualPropertyState `json:"deviceProperties,omitempty"`
	EdgeId           string                         `json:"edgeId,omitempty"`
	// Admin state (locked/unlocked)
	AdminState AdminState `json:"adminState,omitempty"`
	// Operating state (up/down/unknown)
	OperatingState OperatingState `json:"operatingState,omitempty"`
	// current device state
	// +optional
	Conditions []DeviceCondition `json:"conditions,omitempty"`
}

type OperatingState string

type PlatformAdmin struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PlatformAdminSpec   `json:"spec,omitempty"`
	Status PlatformAdminStatus `json:"status,omitempty"`
}

type PlatformAdminCondition struct {
	// Type of in place set condition.
	Type PlatformAdminConditionType `json:"type,omitempty"`

	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status,omitempty"`

	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`

	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty"`
}

type PlatformAdminConditionSeverity string

type PlatformAdminConditionType string

type PlatformAdminList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []PlatformAdmin `json:"items"`
}

type PlatformAdminSpec struct {
	Version string `json:"version,omitempty"`

	ImageRegistry string `json:"imageRegistry,omitempty"`

	PoolName string `json:"poolName,omitempty"`

	ServiceType corev1.ServiceType `json:"serviceType,omitempty"`
	// +optional
	AdditionalService []ServiceTemplateSpec `json:"additionalServices,omitempty"`

	// +optional
	AdditionalDeployment []DeploymentTemplateSpec `json:"additionalDeployments,omitempty"`
}

type PlatformAdminStatus struct {
	// +optional
	Ready bool `json:"ready,omitempty"`
	// +optional
	Initialized bool `json:"initialized,omitempty"`
	// +optional
	ServiceReplicas int32 `json:"serviceReplicas,omitempty"`
	// +optional
	ServiceReadyReplicas int32 `json:"serviceReadyReplicas,omitempty"`
	// +optional
	DeploymentReplicas int32 `json:"deploymentReplicas,omitempty"`
	// +optional
	DeploymentReadyReplicas int32 `json:"deploymentReadyReplicas,omitempty"`

	// Current PlatformAdmin state
	// +optional
	Conditions []PlatformAdminCondition `json:"conditions,omitempty"`
}

type ProtocolProperties map[string]string

type ResourceOperation struct {
	DeviceResource string            `json:"deviceResource,omitempty"`
	Mappings       map[string]string `json:"mappings,omitempty"`
	DefaultValue   string            `json:"defaultValue"`
}

type ResourceProperties struct {
	ReadWrite    string `json:"readWrite,omitempty"`    // Read/Write Permissions set for this property
	Minimum      string `json:"minimum,omitempty"`      // Minimum value that can be get/set from this property
	Maximum      string `json:"maximum,omitempty"`      // Maximum value that can be get/set from this property
	DefaultValue string `json:"defaultValue,omitempty"` // Default value set to this property if no argument is passed
	Mask         string `json:"mask,omitempty"`         // Mask to be applied prior to get/set of property
	Shift        string `json:"shift,omitempty"`        // Shift to be applied after masking, prior to get/set of property
	Scale        string `json:"scale,omitempty"`        // Multiplicative factor to be applied after shifting, prior to get/set of property
	Offset       string `json:"offset,omitempty"`       // Additive factor to be applied after multiplying, prior to get/set of property
	Base         string `json:"base,omitempty"`         // Base for property to be applied to, leave 0 for no power operation (i.e. base ^ property: 2 ^ 10)
	Assertion    string `json:"assertion,omitempty"`
	MediaType    string `json:"mediaType,omitempty"`
	Units        string `json:"units,omitempty"`
	ValueType    string `json:"valueType,omitempty"`
}

type ServiceTemplateSpec struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              corev1.ServiceSpec `json:"spec"`
}