Documentation
¶
Index ¶
- func ImportVariable(variable *ImportContentVariable) basecontentvariable.Descriptor
- type BulkRequest
- type BulkRequestElement
- type BulkRequestElementV2
- type BulkRequestV2
- type BulkResult
- type BulkResultElement
- type DeviceGroup
- type DeviceGroupHelperPagination
- type DeviceGroupHelperResult
- type DeviceGroupOption
- type FilterCriteriaAndSet
- type FilterCriteriaOrSet
- type GetFilteredDevicesV2Options
- type Import
- type ImportConfig
- type ImportContentVariable
- type ImportType
- type ImportTypeConfig
- type ImportTypeFilterCriteria
- type PathOption
- type PermSearchDevice
- type Permissions
- type Selectable
- type Type
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ImportVariable ¶
func ImportVariable(variable *ImportContentVariable) basecontentvariable.Descriptor
ImportVariable views a content variable of an import type as a basecontentvariable.Descriptor. The shape is the shared model's, which carries the fields but no methods, and a method cannot be declared on an alias to another package's type - hence a wrapper rather than methods on ImportContentVariable.
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"`
Devices []string `json:"devices"`
LocalDevices []string `json:"local_devices"`
LocalDeviceOwner string `json:"local_device_owner"`
FilterByDeviceAttributeKeys []string `json:"filter_by_device_attribute_keys"`
}
type BulkRequestV2 ¶
type BulkRequestV2 []BulkRequestElementV2
type BulkResult ¶
type BulkResult []BulkResultElement
type BulkResultElement ¶
type BulkResultElement struct {
Id string `json:"id"`
Selectables []Selectable `json:"selectables"`
}
type DeviceGroup ¶
type DeviceGroupHelperResult ¶
type DeviceGroupHelperResult = devicerepo.DeviceGroupHelperResult
DeviceGroupHelperResult is the device-repository answer, passed on unchanged. The device-group criteria are derived and recomputed there, so a shape of our own would only be a second one to keep in sync - see Controller.DeviceGroupHelper.
type DeviceGroupOption ¶
type DeviceGroupOption = devicerepo.DeviceGroupOption
type FilterCriteriaAndSet ¶
type FilterCriteriaAndSet []devicemodel.FilterCriteria
type FilterCriteriaOrSet ¶
type FilterCriteriaOrSet []devicemodel.FilterCriteria
type GetFilteredDevicesV2Options ¶
type GetFilteredDevicesV2Options struct {
FilterCriteria FilterCriteriaAndSet
IncludeDevices bool
IncludeGroups bool
IncludeImports bool
IncludeIdModified bool
WithDeviceIds []string
WithLocalDeviceIds []string
LocalDeviceOwner string
FilterByDeviceAttributeKeys []string
ImportPathTrimFirstElement bool
}
type ImportConfig ¶
type ImportConfig = models.ImportConfig
type ImportContentVariable ¶
type ImportContentVariable = models.ImportContentVariable
type ImportType ¶
type ImportType = models.ImportType
type ImportTypeConfig ¶
type ImportTypeConfig = models.ImportTypeConfig
type ImportTypeFilterCriteria ¶
type ImportTypeFilterCriteria = models.ImportTypeFilterCriteria
type PathOption ¶
type PathOption = models.PathOption
PathOption is shaped in the shared model, so that a client of the selectables answer does not have to import this service to read it. The aspect fields carry the list next to the deprecated single node; the alias rule is described on the type itself.
type PermSearchDevice ¶
type PermSearchDevice struct {
devicemodel.Device
DisplayName string `json:"display_name"`
Permissions Permissions `json:"permissions"`
Creator string `json:"creator"`
}
type Permissions ¶
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"`
}