Interface GetInterpolatedAssetPropertyValuesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetInterpolatedAssetPropertyValuesRequest.Builder,
,GetInterpolatedAssetPropertyValuesRequest> IoTSiteWiseRequest.Builder
,SdkBuilder<GetInterpolatedAssetPropertyValuesRequest.Builder,
,GetInterpolatedAssetPropertyValuesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetInterpolatedAssetPropertyValuesRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe ID of the asset, in UUID format.endTimeInSeconds
(Long endTimeInSeconds) The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.endTimeOffsetInNanos
(Integer endTimeOffsetInNanos) The nanosecond offset converted fromendTimeInSeconds
.intervalInSeconds
(Long intervalInSeconds) The time interval in seconds over which to interpolate data.intervalWindowInSeconds
(Long intervalWindowInSeconds) The query interval for the window, in seconds.maxResults
(Integer maxResults) The maximum number of results to return for each paginated request.The token to be used for the next set of paginated results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.propertyAlias
(String propertyAlias) The alias that identifies the property, such as an OPC-UA server data stream path (for example,/company/windfarm/3/turbine/7/temperature
).propertyId
(String propertyId) The ID of the asset property, in UUID format.The quality of the asset property value.The quality of the asset property value.startTimeInSeconds
(Long startTimeInSeconds) The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.startTimeOffsetInNanos
(Integer startTimeOffsetInNanos) The nanosecond offset converted fromstartTimeInSeconds
.The interpolation type.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
assetId
The ID of the asset, in UUID format.
- Parameters:
assetId
- The ID of the asset, in UUID format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
propertyId
The ID of the asset property, in UUID format.
- Parameters:
propertyId
- The ID of the asset property, in UUID format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startTimeInSeconds
The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.
- Parameters:
startTimeInSeconds
- The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startTimeOffsetInNanos
GetInterpolatedAssetPropertyValuesRequest.Builder startTimeOffsetInNanos(Integer startTimeOffsetInNanos) The nanosecond offset converted from
startTimeInSeconds
.- Parameters:
startTimeOffsetInNanos
- The nanosecond offset converted fromstartTimeInSeconds
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTimeInSeconds
The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.
- Parameters:
endTimeInSeconds
- The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTimeOffsetInNanos
GetInterpolatedAssetPropertyValuesRequest.Builder endTimeOffsetInNanos(Integer endTimeOffsetInNanos) The nanosecond offset converted from
endTimeInSeconds
.- Parameters:
endTimeOffsetInNanos
- The nanosecond offset converted fromendTimeInSeconds
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
intervalInSeconds
The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.
- Parameters:
intervalInSeconds
- The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The token to be used for the next set of paginated results.
- Parameters:
nextToken
- The token to be used for the next set of paginated results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of results to return for each paginated request. If not specified, the default value is 10.
- Parameters:
maxResults
- The maximum number of results to return for each paginated request. If not specified, the default value is 10.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The interpolation type.
Valid values:
LINEAR_INTERPOLATION | LOCF_INTERPOLATION
-
LINEAR_INTERPOLATION
– Estimates missing data using 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 interpolationIf 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.
- Parameters:
type
- The interpolation type.Valid values:
LINEAR_INTERPOLATION | LOCF_INTERPOLATION
-
LINEAR_INTERPOLATION
– Estimates missing data using 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 interpolationIf 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
intervalWindowInSeconds
GetInterpolatedAssetPropertyValuesRequest.Builder intervalWindowInSeconds(Long intervalWindowInSeconds) 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 thetype
parameter must beLINEAR_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.
- Parameters:
intervalWindowInSeconds
- 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 thetype
parameter must beLINEAR_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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
GetInterpolatedAssetPropertyValuesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetInterpolatedAssetPropertyValuesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-