software.amazon.awssdk.services.iotsitewise.model

Class GetAssetPropertyValueHistoryRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetAssetPropertyValueHistoryRequest.Builder,GetAssetPropertyValueHistoryRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetAssetPropertyValueHistoryRequest
extends IoTSiteWiseRequest
implements ToCopyableBuilder<GetAssetPropertyValueHistoryRequest.Builder,GetAssetPropertyValueHistoryRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetAssetPropertyValueHistoryRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	assetId() The ID of the asset.
static GetAssetPropertyValueHistoryRequest.Builder	builder()
Instant	endDate() The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasQualities() Returns true if the Qualities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Integer	maxResults() The maximum number of results to be returned per paginated request.
String	nextToken() The token to be used for the next set of paginated results.
String	propertyAlias() The property 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.
List<Quality>	qualities() The quality by which to filter asset data.
List<String>	qualitiesAsStrings() The quality by which to filter asset data.
List<SdkField<?>>	sdkFields()
static Class<? extends GetAssetPropertyValueHistoryRequest.Builder>	serializableBuilderClass()
Instant	startDate() The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
TimeOrdering	timeOrdering() The chronological sorting order of the requested information.
String	timeOrderingAsString() The chronological sorting order of the requested information.
GetAssetPropertyValueHistoryRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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 property 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 AWS IoT SiteWise User Guide.

Returns:

The property 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 AWS IoT SiteWise User Guide.

startDate

public final Instant startDate()

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

Returns:

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

endDate

public final Instant endDate()

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

Returns:

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

qualities

public final List<Quality> qualities()

The quality by which to filter asset data.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasQualities() to see if a value was sent in this field.

Returns:

The quality by which to filter asset data.

hasQualities

public final boolean hasQualities()

Returns true if the Qualities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

qualitiesAsStrings

public final List<String> qualitiesAsStrings()

The quality by which to filter asset data.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasQualities() to see if a value was sent in this field.

Returns:

The quality by which to filter asset data.

timeOrdering

public final TimeOrdering timeOrdering()

The chronological sorting order of the requested information.

Default: ASCENDING

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

Returns:

The chronological sorting order of the requested information.

Default: ASCENDING

See Also:

TimeOrdering

timeOrderingAsString

public final String timeOrderingAsString()

The chronological sorting order of the requested information.

Default: ASCENDING

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

Returns:

The chronological sorting order of the requested information.

Default: ASCENDING

See Also:

TimeOrdering

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 be returned per paginated request.

Default: 100

Returns:

The maximum number of results to be returned per paginated request.

Default: 100

toBuilder

public GetAssetPropertyValueHistoryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetAssetPropertyValueHistoryRequest.Builder,GetAssetPropertyValueHistoryRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static GetAssetPropertyValueHistoryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetAssetPropertyValueHistoryRequest.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