Class BatchGetAssetPropertyAggregatesEntry
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BatchGetAssetPropertyAggregatesEntry.Builder,
BatchGetAssetPropertyAggregatesEntry>
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
To identify an asset property, you must specify one of the following:
-
The
assetId
andpropertyId
of an asset property. -
A
propertyAlias
, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature
). To define an asset property's alias, see UpdateAssetProperty.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AggregateType> The data aggregating function.The data aggregating function.final String
assetId()
The ID of the asset in which the asset property was created.builder()
final Instant
endDate()
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.final String
entryId()
The ID of the entry.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) final boolean
For responses, this returns true if the service returned a value for the AggregateTypes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Qualities property.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.final String
The time interval over which to aggregate data.static Class
<? extends BatchGetAssetPropertyAggregatesEntry.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
entryId
The ID of the entry.
- Returns:
- The ID of the entry.
-
assetId
The ID of the asset in which the asset property was created.
- Returns:
- The ID of the asset in which the asset property was created.
-
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.
-
aggregateTypes
The data aggregating function.
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
hasAggregateTypes()
method.- Returns:
- The data aggregating function.
-
hasAggregateTypes
public final boolean hasAggregateTypes()For responses, this returns true if the service returned a value for the AggregateTypes 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. -
aggregateTypesAsStrings
The data aggregating function.
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
hasAggregateTypes()
method.- Returns:
- The data aggregating function.
-
resolution
The time interval over which to aggregate data.
- Returns:
- The time interval over which to aggregate data.
-
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:
-
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<BatchGetAssetPropertyAggregatesEntry.Builder,
BatchGetAssetPropertyAggregatesEntry> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends BatchGetAssetPropertyAggregatesEntry.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-