models

package
v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2020 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAgentUpdates

func GetAgentUpdates(dID, oldAgentID, newAgentID string) []configurator.EntityUpdateCriteria

DEVICE HELPERS Get the necessary updates for agents when changing a device's managing agent

Types

type CambiumChannel

type CambiumChannel struct {

	// client id
	// Min Length: 1
	ClientID string `json:"client_id,omitempty"`

	// client ip
	// Min Length: 1
	ClientIP string `json:"client_ip,omitempty"`

	// client mac
	// Min Length: 1
	ClientMac string `json:"client_mac,omitempty"`

	// client secret
	// Min Length: 1
	ClientSecret string `json:"client_secret,omitempty"`
}

CambiumChannel A cambium channel definition swagger:model cambium_channel

func (*CambiumChannel) MarshalBinary

func (m *CambiumChannel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CambiumChannel) UnmarshalBinary

func (m *CambiumChannel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CambiumChannel) Validate

func (m *CambiumChannel) Validate(formats strfmt.Registry) error

Validate validates this cambium channel

type FrinxChannel

type FrinxChannel struct {

	// authorization
	// Min Length: 1
	Authorization string `json:"authorization,omitempty"`

	// device type
	// Min Length: 1
	DeviceType string `json:"device_type,omitempty"`

	// device version
	// Min Length: 1
	DeviceVersion string `json:"device_version,omitempty"`

	// frinx port
	// Min Length: 1
	FrinxPort int32 `json:"frinx_port,omitempty"`

	// host
	// Min Length: 1
	Host string `json:"host,omitempty"`

	// password
	// Min Length: 1
	Password string `json:"password,omitempty"`

	// port
	// Min Length: 1
	Port int32 `json:"port,omitempty"`

	// transport type
	// Min Length: 1
	TransportType string `json:"transport_type,omitempty"`

	// username
	// Min Length: 1
	Username string `json:"username,omitempty"`
}

FrinxChannel A frinx channel definition swagger:model frinx_channel

func (*FrinxChannel) MarshalBinary

func (m *FrinxChannel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FrinxChannel) UnmarshalBinary

func (m *FrinxChannel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FrinxChannel) Validate

func (m *FrinxChannel) Validate(formats strfmt.Registry) error

Validate validates this frinx channel

type ManagedDevices

type ManagedDevices []string

ManagedDevices managed devices swagger:model managed_devices

func (*ManagedDevices) FromBackendModels

func (m *ManagedDevices) FromBackendModels(networkID string, agentID string) error

func (*ManagedDevices) ToUpdateCriteria

func (m *ManagedDevices) ToUpdateCriteria(networkID string, agentID string) ([]configurator.EntityUpdateCriteria, error)

func (ManagedDevices) Validate

func (m ManagedDevices) Validate(formats strfmt.Registry) error

Validate validates this managed devices

func (*ManagedDevices) ValidateModel

func (m *ManagedDevices) ValidateModel() error

type MutableSymphonyAgent

type MutableSymphonyAgent struct {

	// description
	// Required: true
	Description models2.GatewayDescription `json:"description"`

	// device
	// Required: true
	Device *models3.GatewayDevice `json:"device"`

	// id
	// Required: true
	ID models2.GatewayID `json:"id"`

	// magmad
	// Required: true
	Magmad *models3.MagmadGatewayConfigs `json:"magmad"`

	// managed devices
	// Required: true
	ManagedDevices ManagedDevices `json:"managed_devices"`

	// name
	// Required: true
	Name models2.GatewayName `json:"name"`

	// tier
	// Required: true
	Tier models3.TierID `json:"tier"`
}

MutableSymphonyAgent Description of a Symphony agent with the read-only fields omitted swagger:model mutable_symphony_agent

func (*MutableSymphonyAgent) GetAdditionalEntitiesToLoadOnUpdate

func (m *MutableSymphonyAgent) GetAdditionalEntitiesToLoadOnUpdate(agentID string) []storage.TypeAndKey

func (*MutableSymphonyAgent) GetAdditionalWritesOnCreate

func (m *MutableSymphonyAgent) GetAdditionalWritesOnCreate() []configurator.EntityWriteOperation

func (*MutableSymphonyAgent) GetAdditionalWritesOnUpdate

func (m *MutableSymphonyAgent) GetAdditionalWritesOnUpdate(
	agentID string,
	loadedEntities map[storage.TypeAndKey]configurator.NetworkEntity,
) ([]configurator.EntityWriteOperation, error)

func (*MutableSymphonyAgent) GetMagmadGateway

func (m *MutableSymphonyAgent) GetMagmadGateway() *models2.MagmadGateway

func (*MutableSymphonyAgent) MarshalBinary

func (m *MutableSymphonyAgent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MutableSymphonyAgent) ToConfiguratorEntity

func (m *MutableSymphonyAgent) ToConfiguratorEntity() configurator.NetworkEntity

func (*MutableSymphonyAgent) UnmarshalBinary

func (m *MutableSymphonyAgent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MutableSymphonyAgent) Validate

func (m *MutableSymphonyAgent) Validate(formats strfmt.Registry) error

Validate validates this mutable symphony agent

func (*MutableSymphonyAgent) ValidateModel

func (m *MutableSymphonyAgent) ValidateModel() error

type MutableSymphonyDevice

type MutableSymphonyDevice struct {

	// config
	// Required: true
	Config *SymphonyDeviceConfig `json:"config"`

	// id
	// Required: true
	ID SymphonyDeviceID `json:"id"`

	// managing agent
	ManagingAgent SymphonyDeviceAgent `json:"managing_agent,omitempty"`

	// name
	// Required: true
	Name SymphonyDeviceName `json:"name"`
}

MutableSymphonyDevice A Symphony device with the read-only fields omitted swagger:model mutable_symphony_device

func (*MutableSymphonyDevice) FromBackendModels

func (*MutableSymphonyDevice) MarshalBinary

func (m *MutableSymphonyDevice) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MutableSymphonyDevice) ToEntityUpdateCriteria

func (m *MutableSymphonyDevice) ToEntityUpdateCriteria(nID string) ([]configurator.EntityUpdateCriteria, error)

func (*MutableSymphonyDevice) UnmarshalBinary

func (m *MutableSymphonyDevice) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MutableSymphonyDevice) Validate

func (m *MutableSymphonyDevice) Validate(formats strfmt.Registry) error

Validate validates this mutable symphony device

func (*MutableSymphonyDevice) ValidateModel

func (m *MutableSymphonyDevice) ValidateModel() error

type OtherChannel

type OtherChannel struct {

	// channel props
	// Min Length: 1
	ChannelProps map[string]string `json:"channel_props,omitempty"`
}

OtherChannel A generic channel definition swagger:model other_channel

func (*OtherChannel) MarshalBinary

func (m *OtherChannel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*OtherChannel) UnmarshalBinary

func (m *OtherChannel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*OtherChannel) Validate

func (m *OtherChannel) Validate(formats strfmt.Registry) error

Validate validates this other channel

type SnmpChannel

type SnmpChannel struct {

	// community
	// Min Length: 1
	Community string `json:"community,omitempty"`

	// version
	// Min Length: 1
	Version string `json:"version,omitempty"`
}

SnmpChannel An SNMP channel definition swagger:model snmp_channel

func (*SnmpChannel) MarshalBinary

func (m *SnmpChannel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SnmpChannel) UnmarshalBinary

func (m *SnmpChannel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SnmpChannel) Validate

func (m *SnmpChannel) Validate(formats strfmt.Registry) error

Validate validates this snmp channel

type SymphonyAgent

type SymphonyAgent struct {

	// description
	// Required: true
	Description models2.GatewayDescription `json:"description"`

	// device
	// Required: true
	Device *models3.GatewayDevice `json:"device"`

	// id
	// Required: true
	ID models2.GatewayID `json:"id"`

	// magmad
	// Required: true
	Magmad *models3.MagmadGatewayConfigs `json:"magmad"`

	// managed devices
	// Required: true
	ManagedDevices ManagedDevices `json:"managed_devices"`

	// name
	// Required: true
	Name models2.GatewayName `json:"name"`

	// status
	Status *models3.GatewayStatus `json:"status,omitempty"`

	// tier
	// Required: true
	Tier models3.TierID `json:"tier"`
}

SymphonyAgent Full description of a Symphony agent swagger:model symphony_agent

func NewDefaultSymphonyAgent

func NewDefaultSymphonyAgent() *SymphonyAgent

func (*SymphonyAgent) FromBackendModels

func (m *SymphonyAgent) FromBackendModels(
	magmadEnt, agentEnt configurator.NetworkEntity,
	device *models2.GatewayDevice,
	status *models2.GatewayStatus,
) handlers.GatewayModel

func (*SymphonyAgent) MarshalBinary

func (m *SymphonyAgent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SymphonyAgent) UnmarshalBinary

func (m *SymphonyAgent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SymphonyAgent) Validate

func (m *SymphonyAgent) Validate(formats strfmt.Registry) error

Validate validates this symphony agent

func (*SymphonyAgent) ValidateModel

func (m *SymphonyAgent) ValidateModel() error

type SymphonyDevice

type SymphonyDevice struct {

	// config
	// Required: true
	Config *SymphonyDeviceConfig `json:"config"`

	// id
	// Required: true
	ID SymphonyDeviceID `json:"id"`

	// managing agent
	// Required: true
	ManagingAgent SymphonyDeviceAgent `json:"managing_agent"`

	// name
	// Required: true
	Name SymphonyDeviceName `json:"name"`

	// state
	// Required: true
	State *SymphonyDeviceState `json:"state"`
}

SymphonyDevice Management properties for a Symphony device swagger:model symphony_device

func NewDefaultSymphonyDevice

func NewDefaultSymphonyDevice() *SymphonyDevice

func (*SymphonyDevice) FromBackendModels

func (m *SymphonyDevice) FromBackendModels(ent configurator.NetworkEntity) *SymphonyDevice

func (*SymphonyDevice) MarshalBinary

func (m *SymphonyDevice) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SymphonyDevice) UnmarshalBinary

func (m *SymphonyDevice) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SymphonyDevice) Validate

func (m *SymphonyDevice) Validate(formats strfmt.Registry) error

Validate validates this symphony device

func (*SymphonyDevice) ValidateModel

func (m *SymphonyDevice) ValidateModel() error

type SymphonyDeviceAgent

type SymphonyDeviceAgent string

SymphonyDeviceAgent symphony device agent swagger:model symphony_device_agent

func (*SymphonyDeviceAgent) FromBackendModels

func (m *SymphonyDeviceAgent) FromBackendModels(networkID, deviceID string) error

func (*SymphonyDeviceAgent) ToUpdateCriteria

func (m *SymphonyDeviceAgent) ToUpdateCriteria(networkID, deviceID string) ([]configurator.EntityUpdateCriteria, error)

func (SymphonyDeviceAgent) Validate

func (m SymphonyDeviceAgent) Validate(formats strfmt.Registry) error

Validate validates this symphony device agent

func (*SymphonyDeviceAgent) ValidateModel

func (m *SymphonyDeviceAgent) ValidateModel() error

type SymphonyDeviceConfig

type SymphonyDeviceConfig struct {

	// channels
	Channels *SymphonyDeviceConfigChannels `json:"channels,omitempty"`

	// device config
	DeviceConfig string `json:"device_config,omitempty"`

	// device type
	DeviceType []string `json:"device_type"`

	// host
	Host string `json:"host,omitempty"`

	// platform
	Platform string `json:"platform,omitempty"`
}

SymphonyDeviceConfig Management config for a Symphony device swagger:model symphony_device_config

func NewDefaultSymphonyDeviceConfig

func NewDefaultSymphonyDeviceConfig() *SymphonyDeviceConfig

func (*SymphonyDeviceConfig) FromBackendModels

func (m *SymphonyDeviceConfig) FromBackendModels(networkID, deviceID string) error

func (*SymphonyDeviceConfig) MarshalBinary

func (m *SymphonyDeviceConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SymphonyDeviceConfig) ToUpdateCriteria

func (m *SymphonyDeviceConfig) ToUpdateCriteria(networkID, deviceID string) ([]configurator.EntityUpdateCriteria, error)

func (*SymphonyDeviceConfig) UnmarshalBinary

func (m *SymphonyDeviceConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SymphonyDeviceConfig) Validate

func (m *SymphonyDeviceConfig) Validate(formats strfmt.Registry) error

Validate validates this symphony device config

func (*SymphonyDeviceConfig) ValidateModel

func (m *SymphonyDeviceConfig) ValidateModel() error

type SymphonyDeviceConfigChannels

type SymphonyDeviceConfigChannels struct {

	// cambium channel
	CambiumChannel *CambiumChannel `json:"cambium_channel,omitempty"`

	// frinx channel
	FrinxChannel *FrinxChannel `json:"frinx_channel,omitempty"`

	// other channel
	OtherChannel *OtherChannel `json:"other_channel,omitempty"`

	// snmp channel
	SnmpChannel *SnmpChannel `json:"snmp_channel,omitempty"`
}

SymphonyDeviceConfigChannels symphony device config channels swagger:model SymphonyDeviceConfigChannels

func (*SymphonyDeviceConfigChannels) MarshalBinary

func (m *SymphonyDeviceConfigChannels) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SymphonyDeviceConfigChannels) UnmarshalBinary

func (m *SymphonyDeviceConfigChannels) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SymphonyDeviceConfigChannels) Validate

func (m *SymphonyDeviceConfigChannels) Validate(formats strfmt.Registry) error

Validate validates this symphony device config channels

type SymphonyDeviceID

type SymphonyDeviceID string

SymphonyDeviceID The id of a Symphony device swagger:model symphony_device_id

func (SymphonyDeviceID) Validate

func (m SymphonyDeviceID) Validate(formats strfmt.Registry) error

Validate validates this symphony device id

type SymphonyDeviceName

type SymphonyDeviceName string

SymphonyDeviceName The name of a Symphony device swagger:model symphony_device_name

func (*SymphonyDeviceName) FromBackendModels

func (m *SymphonyDeviceName) FromBackendModels(networkID, deviceID string) error

func (*SymphonyDeviceName) ToUpdateCriteria

func (m *SymphonyDeviceName) ToUpdateCriteria(networkID, deviceID string) ([]configurator.EntityUpdateCriteria, error)

func (SymphonyDeviceName) Validate

func (m SymphonyDeviceName) Validate(formats strfmt.Registry) error

Validate validates this symphony device name

func (*SymphonyDeviceName) ValidateModel

func (m *SymphonyDeviceName) ValidateModel() error

type SymphonyDeviceState

type SymphonyDeviceState struct {

	// raw state
	RawState string `json:"raw_state,omitempty"`
}

SymphonyDeviceState symphony device state swagger:model symphony_device_state

func NewDefaultSymphonyDeviceState

func NewDefaultSymphonyDeviceState() *SymphonyDeviceState

func (*SymphonyDeviceState) MarshalBinary

func (m *SymphonyDeviceState) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SymphonyDeviceState) UnmarshalBinary

func (m *SymphonyDeviceState) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SymphonyDeviceState) Validate

func (m *SymphonyDeviceState) Validate(formats strfmt.Registry) error

Validate validates this symphony device state

func (*SymphonyDeviceState) ValidateModel

func (m *SymphonyDeviceState) ValidateModel() error

type SymphonyNetwork

type SymphonyNetwork struct {

	// description
	// Required: true
	Description models2.NetworkDescription `json:"description"`

	// features
	Features *models3.NetworkFeatures `json:"features,omitempty"`

	// id
	// Required: true
	ID models2.NetworkID `json:"id"`

	// name
	// Required: true
	Name models2.NetworkName `json:"name"`
}

SymphonyNetwork Symphony Network spec swagger:model symphony_network

func NewDefaultSymphonyNetwork

func NewDefaultSymphonyNetwork() *SymphonyNetwork

func (*SymphonyNetwork) FromConfiguratorNetwork

func (m *SymphonyNetwork) FromConfiguratorNetwork(n configurator.Network) interface{}

func (*SymphonyNetwork) GetEmptyNetwork

func (m *SymphonyNetwork) GetEmptyNetwork() handlers.NetworkModel

func (*SymphonyNetwork) MarshalBinary

func (m *SymphonyNetwork) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SymphonyNetwork) ToConfiguratorNetwork

func (m *SymphonyNetwork) ToConfiguratorNetwork() configurator.Network

func (*SymphonyNetwork) ToUpdateCriteria

func (m *SymphonyNetwork) ToUpdateCriteria() configurator.NetworkUpdateCriteria

func (*SymphonyNetwork) UnmarshalBinary

func (m *SymphonyNetwork) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SymphonyNetwork) Validate

func (m *SymphonyNetwork) Validate(formats strfmt.Registry) error

Validate validates this symphony network

func (*SymphonyNetwork) ValidateModel

func (m *SymphonyNetwork) ValidateModel() error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL