Class GetAssetPropertyValueHistoryRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetAssetPropertyValueHistoryRequest.Builder,
GetAssetPropertyValueHistoryRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
assetId()
The ID of the asset, in UUID format.builder()
final Instant
endDate()
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Qualities property.final Integer
The maximum number of results to return for each paginated request.final String
The token to be used for the next set of paginated results.final String
The alias that identifies the property, such as an OPC-UA server data stream path (for example,/company/windfarm/3/turbine/7/temperature
).final String
The ID of the asset property, in UUID format.The quality by which to filter asset data.The quality by which to filter asset data.static Class
<? extends GetAssetPropertyValueHistoryRequest.Builder> final Instant
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.final TimeOrdering
The chronological sorting order of the requested information.final String
The chronological sorting order of the requested information.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
assetId
The ID of the asset, in UUID format.
- Returns:
- The ID of the asset, in UUID format.
-
propertyId
The ID of the asset property, in UUID format.
- Returns:
- The ID of the asset property, in UUID format.
-
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.
-
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
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
The quality by which to filter asset data.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasQualities()
method.- Returns:
- The quality by which to filter asset data.
-
hasQualities
public final boolean hasQualities()For responses, this returns true if the service returned a value for the Qualities property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
qualitiesAsStrings
The quality by which to filter asset data.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasQualities()
method.- Returns:
- The quality by which to filter asset data.
-
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 returnTimeOrdering.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtimeOrderingAsString()
.- Returns:
- The chronological sorting order of the requested information.
Default:
ASCENDING
- See Also:
-
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 returnTimeOrdering.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtimeOrderingAsString()
.- Returns:
- The chronological sorting order of the requested information.
Default:
ASCENDING
- See Also:
-
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
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
-
The size of the result set is equal to 4 MB.
-
The number of data points in the result set is equal to the value of
maxResults
. The maximum value ofmaxResults
is 20000.
- Returns:
- The maximum number of results to return for each paginated request. A result set is returned in the two
cases, whichever occurs first.
-
The size of the result set is equal to 4 MB.
-
The number of data points in the result set is equal to the value of
maxResults
. The maximum value ofmaxResults
is 20000.
-
-
-
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 interfaceToCopyableBuilder<GetAssetPropertyValueHistoryRequest.Builder,
GetAssetPropertyValueHistoryRequest> - Specified by:
toBuilder
in classIoTSiteWiseRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends GetAssetPropertyValueHistoryRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-