1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package iotsitewise
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/iotsitewise/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Get interpolated values for an asset property for a specified time interval,
// during a period of time. If your time series is missing data points during the
// specified time interval, you can use interpolation to estimate the missing data.
// For example, you can use this operation to return the interpolated temperature
// values for a wind turbine every 24 hours over a duration of 7 days. To identify
// an asset property, you must specify one of the following:
// - The assetId and propertyId of an asset property.
// - A propertyAlias , which is a data stream alias (for example,
// /company/windfarm/3/turbine/7/temperature ). To define an asset property's
// alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html)
// .
func (c *Client) GetInterpolatedAssetPropertyValues(ctx context.Context, params *GetInterpolatedAssetPropertyValuesInput, optFns ...func(*Options)) (*GetInterpolatedAssetPropertyValuesOutput, error) {
if params == nil {
params = &GetInterpolatedAssetPropertyValuesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetInterpolatedAssetPropertyValues", params, optFns, c.addOperationGetInterpolatedAssetPropertyValuesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetInterpolatedAssetPropertyValuesOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetInterpolatedAssetPropertyValuesInput struct {
// The inclusive end of the range from which to interpolate data, expressed in
// seconds in Unix epoch time.
//
// This member is required.
EndTimeInSeconds *int64
// The time interval in seconds over which to interpolate data. Each interval
// starts when the previous one ends.
//
// This member is required.
IntervalInSeconds *int64
// The quality of the asset property value. You can use this parameter as a filter
// to choose only the asset property values that have a specific quality.
//
// This member is required.
Quality types.Quality
// The exclusive start of the range from which to interpolate data, expressed in
// seconds in Unix epoch time.
//
// This member is required.
StartTimeInSeconds *int64
// The interpolation type. Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
// - LINEAR_INTERPOLATION – Estimates missing data using linear interpolation (https://en.wikipedia.org/wiki/Linear_interpolation)
// . For example, you can use this operation to return the interpolated temperature
// values for a wind turbine every 24 hours over a duration of 7 days. If the
// interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first
// interpolated value on July 2, 2021, at 9 AM, the second interpolated value on
// July 3, 2021, at 9 AM, and so on.
// - LOCF_INTERPOLATION – Estimates missing data using last observation carried
// forward interpolation If no data point is found for an interval, IoT SiteWise
// returns the last observed data point for the previous interval and carries
// forward this interpolated value until a new data point is found. For example,
// you can get the state of an on-off valve every 24 hours over a duration of 7
// days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns
// the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at
// 9 AM as the first interpolated value. If a data point isn't found after 9 AM on
// July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the
// days.
//
// This member is required.
Type *string
// The ID of the asset, in UUID format.
AssetId *string
// The nanosecond offset converted from endTimeInSeconds .
EndTimeOffsetInNanos *int32
// The query interval for the window, in seconds. IoT SiteWise computes each
// interpolated value by using data points from the timestamp of each interval,
// minus the window to the timestamp of each interval plus the window. If not
// specified, the window ranges between the start time minus the interval and the
// end time plus the interval.
// - If you specify a value for the intervalWindowInSeconds parameter, the value
// for the type parameter must be LINEAR_INTERPOLATION .
// - If a data point isn't found during the specified query window, IoT SiteWise
// won't return an interpolated value for the interval. This indicates that there's
// a gap in the ingested data points.
// For example, you can get the interpolated temperature values for a wind turbine
// every 24 hours over a duration of 7 days. If the interpolation starts on July 1,
// 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7
// AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute
// the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM
// (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the
// second interpolated value, and so on.
IntervalWindowInSeconds *int64
// The maximum number of results to return for each paginated request. If not
// specified, the default value is 10.
MaxResults *int32
// The token to be used for the next set of paginated results.
NextToken *string
// The alias that identifies the property, such as an OPC-UA server data stream
// path (for example, /company/windfarm/3/turbine/7/temperature ). For more
// information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
// in the IoT SiteWise User Guide.
PropertyAlias *string
// The ID of the asset property, in UUID format.
PropertyId *string
// The nanosecond offset converted from startTimeInSeconds .
StartTimeOffsetInNanos *int32
noSmithyDocumentSerde
}
type GetInterpolatedAssetPropertyValuesOutput struct {
// The requested interpolated values.
//
// This member is required.
InterpolatedAssetPropertyValues []types.InterpolatedAssetPropertyValue
// The token for the next set of results, or null if there are no additional
// results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetInterpolatedAssetPropertyValuesMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetInterpolatedAssetPropertyValues{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetInterpolatedAssetPropertyValues{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetInterpolatedAssetPropertyValues"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addEndpointPrefix_opGetInterpolatedAssetPropertyValuesMiddleware(stack); err != nil {
return err
}
if err = addOpGetInterpolatedAssetPropertyValuesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetInterpolatedAssetPropertyValues(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
type endpointPrefix_opGetInterpolatedAssetPropertyValuesMiddleware struct {
}
func (*endpointPrefix_opGetInterpolatedAssetPropertyValuesMiddleware) ID() string {
return "EndpointHostPrefix"
}
func (m *endpointPrefix_opGetInterpolatedAssetPropertyValuesMiddleware) HandleFinalize(ctx context.Context, in middleware.FinalizeInput, next middleware.FinalizeHandler) (
out middleware.FinalizeOutput, metadata middleware.Metadata, err error,
) {
if smithyhttp.GetHostnameImmutable(ctx) || smithyhttp.IsEndpointHostPrefixDisabled(ctx) {
return next.HandleFinalize(ctx, in)
}
req, ok := in.Request.(*smithyhttp.Request)
if !ok {
return out, metadata, fmt.Errorf("unknown transport type %T", in.Request)
}
req.URL.Host = "data." + req.URL.Host
return next.HandleFinalize(ctx, in)
}
func addEndpointPrefix_opGetInterpolatedAssetPropertyValuesMiddleware(stack *middleware.Stack) error {
return stack.Finalize.Insert(&endpointPrefix_opGetInterpolatedAssetPropertyValuesMiddleware{}, "ResolveEndpointV2", middleware.After)
}
// GetInterpolatedAssetPropertyValuesAPIClient is a client that implements the
// GetInterpolatedAssetPropertyValues operation.
type GetInterpolatedAssetPropertyValuesAPIClient interface {
GetInterpolatedAssetPropertyValues(context.Context, *GetInterpolatedAssetPropertyValuesInput, ...func(*Options)) (*GetInterpolatedAssetPropertyValuesOutput, error)
}
var _ GetInterpolatedAssetPropertyValuesAPIClient = (*Client)(nil)
// GetInterpolatedAssetPropertyValuesPaginatorOptions is the paginator options for
// GetInterpolatedAssetPropertyValues
type GetInterpolatedAssetPropertyValuesPaginatorOptions struct {
// The maximum number of results to return for each paginated request. If not
// specified, the default value is 10.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// GetInterpolatedAssetPropertyValuesPaginator is a paginator for
// GetInterpolatedAssetPropertyValues
type GetInterpolatedAssetPropertyValuesPaginator struct {
options GetInterpolatedAssetPropertyValuesPaginatorOptions
client GetInterpolatedAssetPropertyValuesAPIClient
params *GetInterpolatedAssetPropertyValuesInput
nextToken *string
firstPage bool
}
// NewGetInterpolatedAssetPropertyValuesPaginator returns a new
// GetInterpolatedAssetPropertyValuesPaginator
func NewGetInterpolatedAssetPropertyValuesPaginator(client GetInterpolatedAssetPropertyValuesAPIClient, params *GetInterpolatedAssetPropertyValuesInput, optFns ...func(*GetInterpolatedAssetPropertyValuesPaginatorOptions)) *GetInterpolatedAssetPropertyValuesPaginator {
if params == nil {
params = &GetInterpolatedAssetPropertyValuesInput{}
}
options := GetInterpolatedAssetPropertyValuesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &GetInterpolatedAssetPropertyValuesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *GetInterpolatedAssetPropertyValuesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next GetInterpolatedAssetPropertyValues page.
func (p *GetInterpolatedAssetPropertyValuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetInterpolatedAssetPropertyValuesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.GetInterpolatedAssetPropertyValues(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opGetInterpolatedAssetPropertyValues(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetInterpolatedAssetPropertyValues",
}
}
|