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

Class GetInterpolatedAssetPropertyValuesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest
software.amazon.awssdk.services.iotsitewise.model.GetInterpolatedAssetPropertyValuesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetInterpolatedAssetPropertyValuesRequest.Builder,GetInterpolatedAssetPropertyValuesRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetInterpolatedAssetPropertyValuesRequest extends IoTSiteWiseRequest implements ToCopyableBuilder<GetInterpolatedAssetPropertyValuesRequest.Builder,GetInterpolatedAssetPropertyValuesRequest>

  • Method Details

    • assetId

      public final String assetId()

      The ID of the asset, in UUID format.

      Returns:
      The ID of the asset, in UUID format.

    • propertyId

      public final String propertyId()

      The ID of the asset property, in UUID format.

      Returns:
      The ID of the asset property, in UUID format.

    • propertyAlias

      public final 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). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

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

    • startTimeInSeconds

      public final Long startTimeInSeconds()

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

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

    • startTimeOffsetInNanos

      public final Integer startTimeOffsetInNanos()

      The nanosecond offset converted from startTimeInSeconds.

      Returns:
      The nanosecond offset converted from startTimeInSeconds.

    • endTimeInSeconds

      public final Long endTimeInSeconds()

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

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

    • endTimeOffsetInNanos

      public final Integer endTimeOffsetInNanos()

      The nanosecond offset converted from endTimeInSeconds.

      Returns:
      The nanosecond offset converted from endTimeInSeconds.

    • quality

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

      If the service returns an enum value that is not available in the current SDK version, quality will return Quality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from qualityAsString().

      Returns:
      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 Also:

    • qualityAsString

      public final String qualityAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, quality will return Quality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from qualityAsString().

      Returns:
      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 Also:

    • intervalInSeconds

      public final Long intervalInSeconds()

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

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

    • nextToken

      public final String nextToken()

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

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

    • maxResults

      public final Integer maxResults()

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

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

    • type

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

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

    • intervalWindowInSeconds

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

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

    • toBuilder

      public GetInterpolatedAssetPropertyValuesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetInterpolatedAssetPropertyValuesRequest.Builder,GetInterpolatedAssetPropertyValuesRequest>
      Specified by:
      toBuilder in class IoTSiteWiseRequest
      Returns:
      a builder for type T

    • builder

      public static GetInterpolatedAssetPropertyValuesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetInterpolatedAssetPropertyValuesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.