Package software.amazon.awssdk.services.iotsitewise.model

Interface GetInterpolatedAssetPropertyValuesRequest.Builder

    • Method Detail

      • propertyId

        GetInterpolatedAssetPropertyValuesRequest.Builder propertyId​(String 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.

      • startTimeInSeconds

        GetInterpolatedAssetPropertyValuesRequest.Builder startTimeInSeconds​(Long 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 from startTimeInSeconds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endTimeInSeconds

        GetInterpolatedAssetPropertyValuesRequest.Builder endTimeInSeconds​(Long 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 from endTimeInSeconds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • quality

        GetInterpolatedAssetPropertyValuesRequest.Builder quality​(String 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, Quality

      • quality

        GetInterpolatedAssetPropertyValuesRequest.Builder quality​(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.

        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, Quality

      • intervalInSeconds

        GetInterpolatedAssetPropertyValuesRequest.Builder intervalInSeconds​(Long 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

        GetInterpolatedAssetPropertyValuesRequest.Builder nextToken​(String 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

        GetInterpolatedAssetPropertyValuesRequest.Builder maxResults​(Integer 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

        GetInterpolatedAssetPropertyValuesRequest.Builder type​(String 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 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.

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

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.