/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.iotsitewise.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetInterpolatedAssetPropertyValuesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The ID of the asset. *

*/ private String assetId; /** *

* The ID of the asset property. *

*/ private String propertyId; /** *

* 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 in the IoT SiteWise User Guide. *

*/ private String propertyAlias; /** *

* The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time. *

*/ private Long startTimeInSeconds; /** *

* The nanosecond offset converted from startTimeInSeconds. *

*/ private Integer startTimeOffsetInNanos; /** *

* The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time. *

*/ private Long endTimeInSeconds; /** *

* The nanosecond offset converted from endTimeInSeconds. *

*/ private Integer endTimeOffsetInNanos; /** *

* 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. *

*/ private String quality; /** *

* The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends. *

*/ private Long intervalInSeconds; /** *

* The token to be used for the next set of paginated results. *

*/ private String nextToken; /** *

* The maximum number of results to return for each paginated request. If not specified, the default value is 10. *

*/ private Integer maxResults; /** *

* The interpolation type. *

*

* Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION *

* */ private String type; /** *

* 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. *

* * * *

* 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. *

*/ private Long intervalWindowInSeconds; /** *

* The ID of the asset. *

* * @param assetId * The ID of the asset. */ public void setAssetId(String assetId) { this.assetId = assetId; } /** *

* The ID of the asset. *

* * @return The ID of the asset. */ public String getAssetId() { return this.assetId; } /** *

* The ID of the asset. *

* * @param assetId * The ID of the asset. * @return Returns a reference to this object so that method calls can be chained together. */ public GetInterpolatedAssetPropertyValuesRequest withAssetId(String assetId) { setAssetId(assetId); return this; } /** *

* The ID of the asset property. *

* * @param propertyId * The ID of the asset property. */ public void setPropertyId(String propertyId) { this.propertyId = propertyId; } /** *

* The ID of the asset property. *

* * @return The ID of the asset property. */ public String getPropertyId() { return this.propertyId; } /** *

* The ID of the asset property. *

* * @param propertyId * The ID of the asset property. * @return Returns a reference to this object so that method calls can be chained together. */ public GetInterpolatedAssetPropertyValuesRequest withPropertyId(String propertyId) { setPropertyId(propertyId); return this; } /** *

* 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 in the IoT SiteWise User Guide. *

* * @param propertyAlias * 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 in the IoT SiteWise User Guide. */ public void setPropertyAlias(String propertyAlias) { this.propertyAlias = propertyAlias; } /** *

* 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 in the IoT SiteWise User Guide. *

* * @return 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 in the IoT SiteWise User Guide. */ public String getPropertyAlias() { return this.propertyAlias; } /** *

* 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 in the IoT SiteWise User Guide. *

* * @param propertyAlias * 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 in the IoT SiteWise User Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public GetInterpolatedAssetPropertyValuesRequest withPropertyAlias(String propertyAlias) { setPropertyAlias(propertyAlias); return this; } /** *

* The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time. *

* * @param startTimeInSeconds * The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time. */ public void setStartTimeInSeconds(Long startTimeInSeconds) { this.startTimeInSeconds = startTimeInSeconds; } /** *

* The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time. *

* * @return The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time. */ public Long getStartTimeInSeconds() { return this.startTimeInSeconds; } /** *

* The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time. *

* * @param startTimeInSeconds * The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time. * @return Returns a reference to this object so that method calls can be chained together. */ public GetInterpolatedAssetPropertyValuesRequest withStartTimeInSeconds(Long startTimeInSeconds) { setStartTimeInSeconds(startTimeInSeconds); return this; } /** *

* The nanosecond offset converted from startTimeInSeconds. *

* * @param startTimeOffsetInNanos * The nanosecond offset converted from startTimeInSeconds. */ public void setStartTimeOffsetInNanos(Integer startTimeOffsetInNanos) { this.startTimeOffsetInNanos = startTimeOffsetInNanos; } /** *

* The nanosecond offset converted from startTimeInSeconds. *

* * @return The nanosecond offset converted from startTimeInSeconds. */ public Integer getStartTimeOffsetInNanos() { return this.startTimeOffsetInNanos; } /** *

* The nanosecond offset converted from startTimeInSeconds. *

* * @param startTimeOffsetInNanos * The nanosecond offset converted from startTimeInSeconds. * @return Returns a reference to this object so that method calls can be chained together. */ public GetInterpolatedAssetPropertyValuesRequest withStartTimeOffsetInNanos(Integer startTimeOffsetInNanos) { setStartTimeOffsetInNanos(startTimeOffsetInNanos); return this; } /** *

* The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time. *

* * @param endTimeInSeconds * The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time. */ public void setEndTimeInSeconds(Long endTimeInSeconds) { this.endTimeInSeconds = endTimeInSeconds; } /** *

* The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time. *

* * @return The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time. */ public Long getEndTimeInSeconds() { return this.endTimeInSeconds; } /** *

* The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time. *

* * @param endTimeInSeconds * The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time. * @return Returns a reference to this object so that method calls can be chained together. */ public GetInterpolatedAssetPropertyValuesRequest withEndTimeInSeconds(Long endTimeInSeconds) { setEndTimeInSeconds(endTimeInSeconds); return this; } /** *

* The nanosecond offset converted from endTimeInSeconds. *

* * @param endTimeOffsetInNanos * The nanosecond offset converted from endTimeInSeconds. */ public void setEndTimeOffsetInNanos(Integer endTimeOffsetInNanos) { this.endTimeOffsetInNanos = endTimeOffsetInNanos; } /** *

* The nanosecond offset converted from endTimeInSeconds. *

* * @return The nanosecond offset converted from endTimeInSeconds. */ public Integer getEndTimeOffsetInNanos() { return this.endTimeOffsetInNanos; } /** *

* The nanosecond offset converted from endTimeInSeconds. *

* * @param endTimeOffsetInNanos * The nanosecond offset converted from endTimeInSeconds. * @return Returns a reference to this object so that method calls can be chained together. */ public GetInterpolatedAssetPropertyValuesRequest withEndTimeOffsetInNanos(Integer endTimeOffsetInNanos) { setEndTimeOffsetInNanos(endTimeOffsetInNanos); return this; } /** *

* 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. *

* * @param quality * 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. * @see Quality */ public void setQuality(String quality) { this.quality = quality; } /** *

* 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. *

* * @return 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. * @see Quality */ public String getQuality() { return this.quality; } /** *

* 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. *

* * @param quality * 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. * @return Returns a reference to this object so that method calls can be chained together. * @see Quality */ public GetInterpolatedAssetPropertyValuesRequest withQuality(String quality) { setQuality(quality); return this; } /** *

* 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. *

* * @param quality * 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. * @return Returns a reference to this object so that method calls can be chained together. * @see Quality */ public GetInterpolatedAssetPropertyValuesRequest withQuality(Quality quality) { this.quality = quality.toString(); return this; } /** *

* The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends. *

* * @param intervalInSeconds * The time interval in seconds over which to interpolate data. Each interval starts when the previous one * ends. */ public void setIntervalInSeconds(Long intervalInSeconds) { this.intervalInSeconds = intervalInSeconds; } /** *

* The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends. *

* * @return The time interval in seconds over which to interpolate data. Each interval starts when the previous one * ends. */ public Long getIntervalInSeconds() { return this.intervalInSeconds; } /** *

* The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends. *

* * @param intervalInSeconds * The time interval in seconds over which to interpolate data. Each interval starts when the previous one * ends. * @return Returns a reference to this object so that method calls can be chained together. */ public GetInterpolatedAssetPropertyValuesRequest withIntervalInSeconds(Long intervalInSeconds) { setIntervalInSeconds(intervalInSeconds); return this; } /** *

* The token to be used for the next set of paginated results. *

* * @param nextToken * The token to be used for the next set of paginated results. */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

* The token to be used for the next set of paginated results. *

* * @return The token to be used for the next set of paginated results. */ public String getNextToken() { return this.nextToken; } /** *

* The token to be used for the next set of paginated results. *

* * @param nextToken * The token to be used for the next set of paginated results. * @return Returns a reference to this object so that method calls can be chained together. */ public GetInterpolatedAssetPropertyValuesRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** *

* The maximum number of results to return for each paginated request. If not specified, the default value is 10. *

* * @param maxResults * The maximum number of results to return for each paginated request. If not specified, the default value is * 10. */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *

* The maximum number of results to return for each paginated request. If not specified, the default value is 10. *

* * @return The maximum number of results to return for each paginated request. If not specified, the default value * is 10. */ public Integer getMaxResults() { return this.maxResults; } /** *

* The maximum number of results to return for each paginated request. If not specified, the default value is 10. *

* * @param maxResults * The maximum number of results to return for each paginated request. If not specified, the default value is * 10. * @return Returns a reference to this object so that method calls can be chained together. */ public GetInterpolatedAssetPropertyValuesRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** *

* The interpolation type. *

*

* Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION *

* * * @param type * The interpolation type.

*

* Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION *

*