api

Documentation

Index

• Constants
• Variables
• func BatchGetAssetPropertyAggregates(ctx context.Context, client client.SitewiseClient, ...) (models.AssetPropertyValueQuery, *framer.AssetPropertyAggregatesBatch, error)
• func BatchGetAssetPropertyValue(ctx context.Context, client client.SitewiseClient, ...) (models.AssetPropertyValueQuery, *framer.AssetPropertyValueBatch, error)
• func BatchGetAssetPropertyValues(ctx context.Context, client client.SitewiseClient, ...) (models.AssetPropertyValueQuery, *framer.AssetPropertyValueHistoryBatch, error)
• func BatchGetAssetPropertyValuesForTimeRange(ctx context.Context, client client.SitewiseClient, ...) (models.AssetPropertyValueQuery, *framer.AssetPropertyValuesForTimeRangeBatch, ...)
• func DescribeAsset(ctx context.Context, client client.SitewiseClient, ...) (*framer.AssetDescription, error)
• func DescribeAssetModel(ctx context.Context, client client.SitewiseClient, ...) (*framer.AssetModelDescription, error)
• func GetAssetPropertyAggregates(ctx context.Context, client client.SitewiseClient, ...) (models.AssetPropertyValueQuery, *framer.AssetPropertyAggregates, error)
• func GetAssetPropertyDescription(ctx context.Context, client client.SitewiseClient, ...) (*framer.AssetProperty, error)
• func GetAssetPropertyValue(ctx context.Context, client client.SitewiseClient, ...) (models.AssetPropertyValueQuery, *framer.AssetPropertyValue, error)
• func GetAssetPropertyValues(ctx context.Context, client client.SitewiseClient, ...) (models.AssetPropertyValueQuery, *framer.AssetPropertyValueHistory, error)
• func GetAssetPropertyValuesForTimeRange(ctx context.Context, client client.SitewiseClient, ...) (models.AssetPropertyValueQuery, *framer.AssetPropertyValuesForTimeRange, error)
• func GetInterpolatedAssetPropertyValues(ctx context.Context, client client.SitewiseClient, ...) (*framer.InterpolatedAssetPropertyValue, error)
• func ListAssetModels(ctx context.Context, client client.SitewiseClient, ...) (*framer.AssetModels, error)
• func ListAssetProperties(ctx context.Context, client client.ListAssetPropertiesClient, ...) (*framer.AssetProperties, error)
• func ListAssets(ctx context.Context, client client.SitewiseClient, ...) (*framer.Assets, error)
• func ListAssociatedAssets(ctx context.Context, client client.SitewiseClient, ...) (*framer.AssociatedAssets, error)
• func ListTimeSeries(ctx context.Context, client client.SitewiseClient, ...) (*framer.TimeSeries, error)

Constants

const (
	// Max number of entries from: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html#iotsitewise-BatchGetAssetPropertyAggregates-request-entries
	BatchGetAssetPropertyAggregatesMaxEntries = 16
	// Max results number from: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html#iotsitewise-BatchGetAssetPropertyValueHistory-request-maxResults
	BatchGetAssetPropertyValueHistoryMaxResults = 20000

	// Max number of entries from: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html#iotsitewise-BatchGetAssetPropertyValueHistory-request-entries
	BatchGetAssetPropertyValueHistoryMaxEntries = 16
	// Max results number from: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html#iotsitewise-BatchGetAssetPropertyAggregates-request-maxResults
	BatchGetAssetPropertyAggregatesMaxResults = 4000

	// Max number of entries from: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html#iotsitewise-BatchGetAssetPropertyValue-request-entries
	BatchGetAssetPropertyValueMaxEntries = 128
)

Variables

var (
	LOCF_INTERPOLATION   string = "LOCF_INTERPOLATION"
	LINEAR_INTERPOLATION string = "LINEAR_INTERPOLATION"
)

var (
	MaxSitewiseResults = aws.Int64(250)
)

Functions

func BatchGetAssetPropertyAggregates

func BatchGetAssetPropertyAggregates(ctx context.Context, client client.SitewiseClient,
	query models.AssetPropertyValueQuery) (models.AssetPropertyValueQuery, *framer.AssetPropertyAggregatesBatch, error)

func BatchGetAssetPropertyValue

func BatchGetAssetPropertyValue(ctx context.Context, client client.SitewiseClient, query models.AssetPropertyValueQuery) (models.AssetPropertyValueQuery, *framer.AssetPropertyValueBatch, error)

func BatchGetAssetPropertyValues

func BatchGetAssetPropertyValues(ctx context.Context, client client.SitewiseClient,
	query models.AssetPropertyValueQuery) (models.AssetPropertyValueQuery, *framer.AssetPropertyValueHistoryBatch, error)

func BatchGetAssetPropertyValuesForTimeRange

func BatchGetAssetPropertyValuesForTimeRange(ctx context.Context, client client.SitewiseClient,
	query models.AssetPropertyValueQuery) (models.AssetPropertyValueQuery, *framer.AssetPropertyValuesForTimeRangeBatch, error)

func DescribeAsset

func DescribeAsset(ctx context.Context, client client.SitewiseClient, query models.DescribeAssetQuery) (*framer.AssetDescription, error)

func DescribeAssetModel

func DescribeAssetModel(ctx context.Context, client client.SitewiseClient, query models.DescribeAssetModelQuery) (*framer.AssetModelDescription, error)

func GetAssetPropertyAggregates

func GetAssetPropertyAggregates(ctx context.Context, client client.SitewiseClient,
	query models.AssetPropertyValueQuery) (models.AssetPropertyValueQuery, *framer.AssetPropertyAggregates, error)

func GetAssetPropertyDescription

func GetAssetPropertyDescription(ctx context.Context, client client.SitewiseClient, query models.DescribeAssetPropertyQuery) (*framer.AssetProperty, error)

func GetAssetPropertyValue

func GetAssetPropertyValue(ctx context.Context, client client.SitewiseClient, query models.AssetPropertyValueQuery) (models.AssetPropertyValueQuery, *framer.AssetPropertyValue, error)

func GetAssetPropertyValues

func GetAssetPropertyValues(ctx context.Context, client client.SitewiseClient,
	query models.AssetPropertyValueQuery) (models.AssetPropertyValueQuery, *framer.AssetPropertyValueHistory, error)

func GetAssetPropertyValuesForTimeRange

func GetAssetPropertyValuesForTimeRange(ctx context.Context, client client.SitewiseClient,
	query models.AssetPropertyValueQuery) (models.AssetPropertyValueQuery, *framer.AssetPropertyValuesForTimeRange, error)

func GetInterpolatedAssetPropertyValues

func GetInterpolatedAssetPropertyValues(ctx context.Context, client client.SitewiseClient, query models.AssetPropertyValueQuery) (*framer.InterpolatedAssetPropertyValue, error)

func ListAssetModels

func ListAssetModels(ctx context.Context, client client.SitewiseClient, query models.ListAssetModelsQuery) (*framer.AssetModels, error)

func ListAssetProperties

func ListAssetProperties(ctx context.Context, client client.ListAssetPropertiesClient, query models.ListAssetPropertiesQuery) (*framer.AssetProperties, error)

func ListAssets

func ListAssets(ctx context.Context, client client.SitewiseClient, query models.ListAssetsQuery) (*framer.Assets, error)

func ListAssociatedAssets

func ListAssociatedAssets(ctx context.Context, client client.SitewiseClient, query models.ListAssociatedAssetsQuery) (*framer.AssociatedAssets, error)

func ListTimeSeries

func ListTimeSeries(ctx context.Context, client client.SitewiseClient, query models.ListTimeSeriesQuery) (*framer.TimeSeries, error)