models

package
v1.25.2 Latest Latest
Warning

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

 Go to latest Published: Jan 17, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	QueryTypePropertyValueHistory = "PropertyValueHistory"
	QueryTypePropertyValue        = "PropertyValue"
	QueryTypePropertyAggregate    = "PropertyAggregate"
	QueryTypePropertyInterpolated = "PropertyInterpolated"
	QueryTypeListAssetModels      = "ListAssetModels"
	QueryTypeListAssets           = "ListAssets"
	QueryTypeListAssociatedAssets = "ListAssociatedAssets"
	QueryTypeDescribeAsset        = "DescribeAsset"
	QueryTypeDescribeAssetModel   = "DescribeAssetModel"
	QueryTypeListAssetProperties  = "ListAssetProperties"
	QueryTypeListTimeSeries       = "ListTimeSeries"
)
View Source 
const (
	AggregateMin    = "MINIMUM"
	AggregateMax    = "MAXIMUM"
	AggregateCount  = "COUNT"
	AggregateAvg    = "AVERAGE"
	AggregateStdDev = "STANDARD_DEVIATION"
	AggregateSum    = "SUM"
)
View Source 
const EDGE_AUTH_MODE_DEFAULT string = "default"
View Source 
const EDGE_AUTH_MODE_LDAP string = "ldap"
View Source 
const EDGE_AUTH_MODE_LINUX string = "linux"
View Source 
const EDGE_REGION string = "Edge"
View Source 
const (
	PropertyQueryResolutionRaw = "RAW"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AWSSiteWiseDataSourceSetting added in v1.2.4 

type AWSSiteWiseDataSourceSetting struct {
	awsds.AWSDatasourceSettings
	Cert         string `json:"-"`
	EdgeAuthMode string `json:"edgeAuthMode"`
	EdgeAuthUser string `json:"edgeAuthUser"`
	EdgeAuthPass string `json:"-"`
}

func (*AWSSiteWiseDataSourceSetting) Load added in v1.2.4 

func (s *AWSSiteWiseDataSourceSetting) Load(config backend.DataSourceInstanceSettings) error

func (*AWSSiteWiseDataSourceSetting) ToAWSDatasourceSettings added in v1.2.4 

func (s *AWSSiteWiseDataSourceSetting) ToAWSDatasourceSettings() awsds.AWSDatasourceSettings

func (*AWSSiteWiseDataSourceSetting) Validate added in v1.2.4 

func (s *AWSSiteWiseDataSourceSetting) Validate() error

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"`
	LastObservation bool     `json:"lastObservation,omitempty"`
	TimeOrdering    string   `json:"timeOrdering,omitempty"`
	FlattenL4e      bool     `json:"flattenL4e,omitempty"`
}

AssetPropertyValueQuery encapsulates params for all 3 'Get' data APIs in Sitewise. Each API handler will simply ignore the unneeded props. This is done simply due to lack of solid generics support in golang.

func GetAssetPropertyValueQuery 

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

type AuthInfo added in v1.2.4 

type AuthInfo struct {
	Username          string    `json:"username,omitempty"`
	AccessKeyId       string    `json:"accessKeyId,omitempty"`
	SecretAccessKey   string    `json:"secretAccessKey,omitempty"`
	SessionToken      string    `json:"sessionToken,omitempty"`
	SessionExpiryTime time.Time `json:"sessionExpiryTime,omitempty"`
	AuthMechanism     string    `json:"authMechanism,omitempty"`
}

type Authenticator added in v1.2.4 

type Authenticator interface {
	Authenticate(ctx context.Context) (AuthInfo, error)
}

type BaseQuery 

type BaseQuery struct {
	AwsRegion string `json:"region,omitempty"`
	// Deprecated: use assetIds
	AssetId             string            `json:"assetId,omitempty"`
	AssetIds            []string          `json:"assetIds,omitempty"`
	PropertyId          string            `json:"propertyId,omitempty"`
	PropertyAlias       string            `json:"propertyAlias,omitempty"`
	NextToken           string            `json:"nextToken,omitempty"`
	NextTokens          map[string]string `json:"nextTokens,omitempty"`
	MaxPageAggregations int               `json:"maxPageAggregations,omitempty"`
	ResponseFormat      string            `json:"responseFormat,omitempty"`

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

func (*BaseQuery) MigrateAssetId added in v1.6.0 

func (query *BaseQuery) MigrateAssetId()

MigrateAssetId handles AssetId <--> AssetIds backward compatibility. This is needed for compatibility for queries saved before the Batch API changes were introduced in 1.6.0

type DescribeAssetModelQuery added in v1.1.0 

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

func GetDescribeAssetModelQuery added in v1.1.0 

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 L4eAnomalyDiagnostics added in v1.18.0 

type L4eAnomalyDiagnostics struct {
	Name  string  `json:"name,omitempty"`
	Value float64 `json:"value,omitempty"`
}

type L4eAnomalyResult added in v1.18.0 

type L4eAnomalyResult struct {
	AnomalyScore     float64                 `json:"anomaly_score,omitempty"`
	PredictionReason string                  `json:"prediction_reason,omitempty"`
	Diagnostics      []L4eAnomalyDiagnostics `json:"diagnostics,omitempty"`
}

type ListAssetModelsQuery 

type ListAssetModelsQuery struct {
	BaseQuery
}

func GetListAssetModelsQuery 

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

type ListAssetPropertiesQuery added in v1.17.0 

type ListAssetPropertiesQuery struct {
	BaseQuery
}

func GetListAssetPropertiesQuery added in v1.17.0 

func GetListAssetPropertiesQuery(dq *backend.DataQuery) (*ListAssetPropertiesQuery, 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"`
	LoadAllChildren bool   `json:"loadAllChildren,omitempty"`
}

func GetListAssociatedAssetsQuery 

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

type ListTimeSeriesQuery added in v1.23.0 

type ListTimeSeriesQuery struct {
	BaseQuery
	TimeSeriesType string `json:"timeSeriesType,omitempty"`
	AssetId        string `json:"assetId,omitempty"`
	AliasPrefix    string `json:"aliasPrefix,omitempty"`
}

func GetListTimeSeriesQuery added in v1.23.0 

func GetListTimeSeriesQuery(dq *backend.DataQuery) (*ListTimeSeriesQuery, error)

type SitewiseCustomMeta 

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

SitewiseCustomMeta is the standard metadata

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.