model

Documentation

Index

• Constants
• type BulkRequest
• type BulkRequestElement
• type BulkRequestElementV2
• type BulkRequestV2
• type BulkResult
• type BulkResultElement
• type ConditionConfig
• type DeviceGroup
• type DeviceGroupHelperResult
• type DeviceGroupOption
• type FilterCriteriaAndSet
• type FilterCriteriaOrSet
• type Import
• type ImportConfig
• type ImportContentVariable
  • func (this *ImportContentVariable) GetAspectId() string
  • func (this *ImportContentVariable) GetCharacteristicId() string
  • func (this *ImportContentVariable) GetFunctionId() string
  • func (this *ImportContentVariable) GetIsVoid() bool
  • func (this *ImportContentVariable) GetName() string
  • func (this *ImportContentVariable) GetSubContentVariables() []basecontentvariable.Descriptor
• type ImportType
• type ImportTypeConfig
• type ImportTypeFilterCriteria
  • func (this ImportTypeFilterCriteria) Short() string
• type PathOption
• type PermSearchDevice
• type Permissions
• type QueryCheckIds
• type QueryFind
• type QueryListCommons
• type QueryListIds
• type QueryMessage
• type QueryOperationType
• type Selectable
• type Selection
• type Type

Constants

const (
	QueryEqualOperation             = client.QueryEqualOperation
	QueryUnequalOperation           = client.QueryUnequalOperation
	QueryAnyValueInFeatureOperation = client.QueryAnyValueInFeatureOperation
)

Types

type BulkRequest

type BulkRequest []BulkRequestElement

type BulkRequestElement

type BulkRequestElement struct {
	Id                string                   `json:"id"`
	FilterInteraction *devicemodel.Interaction `json:"filter_interaction"`
	FilterProtocols   []string                 `json:"filter_protocols"`
	Criteria          FilterCriteriaAndSet     `json:"criteria"`
	IncludeGroups     bool                     `json:"include_groups"`
	IncludeImports    bool                     `json:"include_imports"`
	LocalDevices      []string                 `json:"local_devices"`
}

type BulkRequestElementV2

type BulkRequestElementV2 struct {
	Id                         string               `json:"id"`
	Criteria                   FilterCriteriaAndSet `json:"criteria"`
	IncludeGroups              bool                 `json:"include_groups"`
	IncludeImports             bool                 `json:"include_imports"`
	IncludeDevices             bool                 `json:"include_devices"`
	IncludeIdModifiedDevices   bool                 `json:"include_id_modified_devices"`
	ImportPathTrimFirstElement bool                 `json:"import_path_trim_first_element"`
	LocalDevices               []string             `json:"local_devices"`
}

type BulkRequestV2

type BulkRequestV2 []BulkRequestElementV2

type BulkResult

type BulkResult []BulkResultElement

type BulkResultElement

type BulkResultElement struct {
	Id          string       `json:"id"`
	Selectables []Selectable `json:"selectables"`
}

type ConditionConfig

type ConditionConfig = client.ConditionConfig

type DeviceGroup

type DeviceGroup struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

type DeviceGroupHelperResult

type DeviceGroupHelperResult struct {
	Criteria []devicemodel.DeviceGroupFilterCriteria `json:"criteria"`
	Options  []DeviceGroupOption                     `json:"options"`
}

type DeviceGroupOption

type DeviceGroupOption struct {
	Device                  PermSearchDevice                        `json:"device"`
	RemovesCriteria         []devicemodel.DeviceGroupFilterCriteria `json:"removes_criteria"`
	MaintainsGroupUsability bool                                    `json:"maintains_group_usability"`
}

type FilterCriteriaAndSet

type FilterCriteriaAndSet []devicemodel.FilterCriteria

type FilterCriteriaOrSet

type FilterCriteriaOrSet []devicemodel.FilterCriteria

type Import

type Import struct {
	Id           string         `json:"id"`
	Name         string         `json:"name"`
	ImportTypeId string         `json:"import_type_id"`
	Image        string         `json:"image"`
	KafkaTopic   string         `json:"kafka_topic"`
	Configs      []ImportConfig `json:"configs"`
	Restart      *bool          `json:"restart"`
}

type ImportConfig

type ImportConfig struct {
	Name  string      `json:"name"`
	Value interface{} `json:"value"`
}

type ImportContentVariable

type ImportContentVariable struct {
	Name                string                  `json:"name"`
	Type                Type                    `json:"type"`
	CharacteristicId    string                  `json:"characteristic_id"`
	SubContentVariables []ImportContentVariable `json:"sub_content_variables"`
	UseAsTag            bool                    `json:"use_as_tag"`
	FunctionId          string                  `json:"function_id,omitempty"`
	AspectId            string                  `json:"aspect_id,omitempty"`
}

func (*ImportContentVariable) GetAspectId

func (this *ImportContentVariable) GetAspectId() string

func (*ImportContentVariable) GetCharacteristicId

func (this *ImportContentVariable) GetCharacteristicId() string

func (*ImportContentVariable) GetFunctionId

func (this *ImportContentVariable) GetFunctionId() string

func (*ImportContentVariable) GetIsVoid

func (this *ImportContentVariable) GetIsVoid() bool

func (*ImportContentVariable) GetName

func (this *ImportContentVariable) GetName() string

func (*ImportContentVariable) GetSubContentVariables

func (this *ImportContentVariable) GetSubContentVariables() []basecontentvariable.Descriptor

type ImportType

type ImportType struct {
	Id             string                `json:"id"`
	Name           string                `json:"name"`
	Description    string                `json:"description"`
	Image          string                `json:"image"`
	DefaultRestart bool                  `json:"default_restart"`
	Configs        []ImportTypeConfig    `json:"configs"`
	Output         ImportContentVariable `json:"output"`
	Owner          string                `json:"owner"`
}

type ImportTypeConfig

type ImportTypeConfig struct {
	Name         string      `json:"name"`
	Description  string      `json:"description"`
	Type         Type        `json:"type"`
	DefaultValue interface{} `json:"default_value"`
}

type ImportTypeFilterCriteria

type ImportTypeFilterCriteria struct {
	FunctionId string `json:"function_id"`
	AspectId   string `json:"aspect_id"`
}

func (ImportTypeFilterCriteria) Short

func (this ImportTypeFilterCriteria) Short() string

type PathOption

type PathOption struct {
	Path             string                     `json:"path"`
	CharacteristicId string                     `json:"characteristicId"`
	AspectNode       devicemodel.AspectNode     `json:"aspectNode"`
	FunctionId       string                     `json:"functionId"`
	IsVoid           bool                       `json:"isVoid"`
	Value            interface{}                `json:"value,omitempty"`
	Type             Type                       `json:"type,omitempty"`
	Configurables    []devicemodel.Configurable `json:"configurables,omitempty"`
	Interaction      devicemodel.Interaction    `json:"interaction,omitempty"`
}

type PermSearchDevice

type PermSearchDevice struct {
	devicemodel.Device
	DisplayName string      `json:"display_name"`
	Permissions Permissions `json:"permissions"`
	Shared      bool        `json:"shared"`
	Creator     string      `json:"creator"`
}

type Permissions

type Permissions struct {
	R bool `json:"r"`
	W bool `json:"w"`
	X bool `json:"x"`
	A bool `json:"a"`
}

type QueryCheckIds

type QueryCheckIds = client.QueryCheckIds

type QueryFind

type QueryFind = client.QueryFind

type QueryListCommons

type QueryListCommons = client.QueryListCommons

type QueryListIds

type QueryListIds = client.QueryListIds

type QueryMessage

type QueryMessage = client.QueryMessage

type QueryOperationType

type QueryOperationType = client.QueryOperationType

type Selectable

type Selectable struct {
	Device             *PermSearchDevice       `json:"device,omitempty"`
	Services           []devicemodel.Service   `json:"services,omitempty"`
	DeviceGroup        *DeviceGroup            `json:"device_group,omitempty"`
	Import             *Import                 `json:"import,omitempty"`
	ImportType         *ImportType             `json:"importType,omitempty"`
	ServicePathOptions map[string][]PathOption `json:"servicePathOptions,omitempty"`
}

type Selection

type Selection = client.Selection

type Type

type Type = devicemodel.Type