messages

Documentation

Index

• type FindConfigurablesRequest
• type MarshallingRequest
• type MarshallingV2Request
• type PathOptionsQuery
• type UnmarshallingRequest
• type UnmarshallingV2Request

Types

type FindConfigurablesRequest

type FindConfigurablesRequest struct {
	CharacteristicId string          `json:"characteristic_id"`
	Services         []model.Service `json:"services"`
}

type MarshallingRequest

type MarshallingRequest struct {
	Service          model.Service                `json:"service,omitempty"`           //semi-optional, may be determined by request path
	Protocol         *model.Protocol              `json:"protocol,omitempty"`          //semi-optional, may be determined by request path
	CharacteristicId string                       `json:"characteristic_id,omitempty"` //semi-optional, may be determined by request path
	Configurables    []configurables.Configurable `json:"configurables,omitempty"`     //optional, may be empty
	Data             interface{}                  `json:"data"`

	/*
		optional
		if len > 0: apply data only on given ContentVariable paths
		useful if 2 variables have the same characteristic assigned but are used with different functions or aspects
	*/
	PathAllowList []string `json:"path_allow_list,omitempty"`
}

type MarshallingV2Request

type MarshallingV2Request struct {
	Service  model.Service                    `json:"service"`  //semi-optional, may be determined by request path
	Protocol model.Protocol                   `json:"protocol"` //semi-optional, may be determined by service
	Data     []model.MarshallingV2RequestData `json:"data"`
}

type PathOptionsQuery

type PathOptionsQuery struct {
	DeviceTypeIds          []string `json:"device_type_ids"`
	FunctionId             string   `json:"function_id"`
	AspectId               string   `json:"aspect_id"`
	CharacteristicIdFilter []string `json:"characteristic_id_filter"`
	WithoutEnvelope        bool     `json:"without_envelope"`
}

type UnmarshallingRequest

type UnmarshallingRequest struct {
	Service              model.Service     `json:"service,omitempty"`           //semi-optional, may be determined by request path
	Protocol             *model.Protocol   `json:"protocol,omitempty"`          //semi-optional, may be determined by service
	CharacteristicId     string            `json:"characteristic_id,omitempty"` //semi-optional, may be determined by request path
	Message              map[string]string `json:"message"`
	ContentVariableHints []string          `json:"content_variable_hints"` //optional

	/*
		optional
		if len > 0: apply data only on given ContentVariable paths
		useful if 2 variables have the same characteristic assigned but are used with different functions or aspects
	*/
	PathAllowList []string `json:"path_allow_list,omitempty"`
}

type UnmarshallingV2Request

type UnmarshallingV2Request struct {
	Service          model.Service  `json:"service"`           //semi-optional, may be determined by request path
	Protocol         model.Protocol `json:"protocol"`          //semi-optional, may be determined by service
	CharacteristicId string         `json:"characteristic_id"` //semi-optional, may be determined by request path

	Message          map[string]string      `json:"message"`           //semi-optional; may be needed to create serialized_output
	SerializedOutput map[string]interface{} `json:"serialized_output"` //semi-optional; may be created from message

	Path         string           `json:"path"`           //semi-optional, may be determent by FunctionId and AspectNode
	FunctionId   string           `json:"function_id"`    //semi-optional, to determine Path if not set
	AspectNode   model.AspectNode `json:"aspect_node"`    //semi-optional, to determine Path if not set, may itself be determent by AspectNodeId
	AspectNodeId string           `json:"aspect_node_id"` //semi-optional, to determine AspectNode if not set
}