models

Documentation

Index

• Constants
• type AssetPropertyValueQuery
  • func GetAssetPropertyValueQuery(dq *backend.DataQuery) (*AssetPropertyValueQuery, error)
• type BaseQuery
• type DescribeAssetModelQuery
  • func GetDescribeAssetModelQuery(dq *backend.DataQuery) (*DescribeAssetModelQuery, error)
• type DescribeAssetPropertyQuery
• type DescribeAssetQuery
  • func GetDescribeAssetQuery(dq *backend.DataQuery) (*DescribeAssetQuery, error)
• type ListAssetModelsQuery
  • func GetListAssetModelsQuery(dq *backend.DataQuery) (*ListAssetModelsQuery, error)
• type ListAssetsQuery
  • func GetListAssetsQuery(dq *backend.DataQuery) (*ListAssetsQuery, error)
• type ListAssociatedAssetsQuery
  • func GetListAssociatedAssetsQuery(dq *backend.DataQuery) (*ListAssociatedAssetsQuery, error)
• type SitewiseCustomMeta

Constants

const (
	QueryTypePropertyValueHistory = "PropertyValueHistory"
	QueryTypePropertyValue        = "PropertyValue"
	QueryTypePropertyAggregate    = "PropertyAggregate"
	QueryTypeListAssetModels      = "ListAssetModels"
	QueryTypeListAssets           = "ListAssets"
	QueryTypeListAssociatedAssets = "ListAssociatedAssets"
	QueryTypeDescribeAsset        = "DescribeAsset"
	QueryTypeDescribeAssetModel   = "DescribeAssetModel"
)

const (
	AggregateMin    = "MINIMUM"
	AggregateMax    = "MAXIMUM"
	AggregateCount  = "COUNT"
	AggregateAvg    = "AVERAGE"
	AggregateStdDev = "STANDARD_DEVIATION"
	AggregateSum    = "SUM"
)

Types

type AssetPropertyValueQuery

type AssetPropertyValueQuery struct {
	BaseQuery
	AggregateTypes []string `json:"aggregates,omitempty"` // Not used for the history query
	Quality        string   `json:"quality,omitempty"`
	Resolution     string   `json:"resolution,omitempty"`
}

AssetPropertyValueQuery encapsulates params for all 3 'Get' data APIs in Sitewise. Each API handler will simply ignore the unneeeded props. NOTES: We have decided to not support propertyAlias targets, as there is no good way to go from propertyAlias -> assetId/propertyId. This is done simply due to lack of solid generics support in golang.

func GetAssetPropertyValueQuery

func GetAssetPropertyValueQuery(dq *backend.DataQuery) (*AssetPropertyValueQuery, error)

type BaseQuery

type BaseQuery struct {
	AwsRegion           string `json:"region,omitempty"`
	AssetId             string `json:"assetId,omitempty"`
	PropertyId          string `json:"propertyId,omitempty"`
	NextToken           string `json:"nextToken,omitempty"`
	MaxPageAggregations int    `json:"maxPageAggregations,omitempty"`

	Interval      time.Duration     `json:"-"`
	TimeRange     backend.TimeRange `json:"-"`
	MaxDataPoints int64             `json:"-"`
	QueryType     string            `json:"-"`
}

type DescribeAssetModelQuery

type DescribeAssetModelQuery struct {
	BaseQuery
	AssetModelId string `json:"assetModelId"`
}

func GetDescribeAssetModelQuery

func GetDescribeAssetModelQuery(dq *backend.DataQuery) (*DescribeAssetModelQuery, error)

type DescribeAssetPropertyQuery

type DescribeAssetPropertyQuery struct {
	BaseQuery
}

type DescribeAssetQuery

type DescribeAssetQuery struct {
	BaseQuery
}

func GetDescribeAssetQuery

func GetDescribeAssetQuery(dq *backend.DataQuery) (*DescribeAssetQuery, error)

type ListAssetModelsQuery

type ListAssetModelsQuery struct {
	BaseQuery
}

func GetListAssetModelsQuery

func GetListAssetModelsQuery(dq *backend.DataQuery) (*ListAssetModelsQuery, error)

type ListAssetsQuery

type ListAssetsQuery struct {
	BaseQuery
	ModelId string `json:"modelId,omitempty"`
	Filter  string `json:"filter,omitempty"`
}

func GetListAssetsQuery

func GetListAssetsQuery(dq *backend.DataQuery) (*ListAssetsQuery, error)

type ListAssociatedAssetsQuery

type ListAssociatedAssetsQuery struct {
	BaseQuery
	HierarchyId string `json:"hierarchyId,omitempty"`
}

func GetListAssociatedAssetsQuery

func GetListAssociatedAssetsQuery(dq *backend.DataQuery) (*ListAssociatedAssetsQuery, error)

type SitewiseCustomMeta

type SitewiseCustomMeta struct {
	NextToken  string   `json:"nextToken,omitempty"`
	Resolution string   `json:"resolution,omitempty"`
	Aggregates []string `json:"aggregates,omitempty"`
}

SitewiseCustomMeta is the standard metadata