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(value="software.amazon.awssdk:codegen")
public final class GetInterpolatedAssetPropertyValuesRequest
extends IoTSiteWiseRequest
implements ToCopyableBuilder<GetInterpolatedAssetPropertyValuesRequest.Builder,GetInterpolatedAssetPropertyValuesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetInterpolatedAssetPropertyValuesRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	assetId() The ID of the asset.
static GetInterpolatedAssetPropertyValuesRequest.Builder	builder()
Long	endTimeInSeconds() The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.
Integer	endTimeOffsetInNanos() The nanosecond offset converted from endTimeInSeconds.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	intervalInSeconds() The time interval in seconds over which to interpolate data.
Long	intervalWindowInSeconds() The query interval for the window, in seconds.
Integer	maxResults() The maximum number of results to return for each paginated request.
String	nextToken() The token to be used for the next set of paginated results.
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).
String	propertyId() The ID of the asset property.
Quality	quality() The quality of the asset property value.
String	qualityAsString() The quality of the asset property value.
List<SdkField<?>>	sdkFields()
static Class<? extends GetInterpolatedAssetPropertyValuesRequest.Builder>	serializableBuilderClass()
Long	startTimeInSeconds() The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.
Integer	startTimeOffsetInNanos() The nanosecond offset converted from startTimeInSeconds.
GetInterpolatedAssetPropertyValuesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	type() The interpolation type.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

assetId

public final String assetId()

The ID of the asset.

Returns:

The ID of the asset.

propertyId

public final String propertyId()

The ID of the asset property.

Returns:

The ID of the asset property.

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:

Quality

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:

Quality

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()

Specified by:

toBuilder in interface ToCopyableBuilder<GetInterpolatedAssetPropertyValuesRequest.Builder,GetInterpolatedAssetPropertyValuesRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo