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

Class AssetPropertySummary

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.AssetPropertySummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AssetPropertySummary.Builder,AssetPropertySummary>

@Generated("software.amazon.awssdk:codegen")
public final class AssetPropertySummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AssetPropertySummary.Builder,AssetPropertySummary>

Contains a summary of a property associated with an asset.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssetPropertySummary.Builder

Method Summary

Modifier and Type	Method	Description
String	alias()	The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature).
String	assetCompositeModelId()	The ID of the composite model that contains the asset property.
static AssetPropertySummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId()	The external ID of the property.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPath()	For responses, this returns true if the service returned a value for the Path property.
String	id()	The ID of the property.
PropertyNotification	notification()	Returns the value of the Notification property for this object.
List<AssetPropertyPathSegment>	path()	The structured path to the property from the root of the asset.
List<SdkField<?>>	sdkFields()
static Class<? extends AssetPropertySummary.Builder>	serializableBuilderClass()
AssetPropertySummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	unit()	The unit of measure (such as Newtons or RPM) of the asset property.

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

id

public final String id()

The ID of the property.

Returns:

The ID of the property.

alias

public final String alias()

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.

unit

public final String unit()

The unit of measure (such as Newtons or RPM) of the asset property.

Returns:

The unit of measure (such as Newtons or RPM) of the asset property.

notification

public final PropertyNotification notification()

Returns the value of the Notification property for this object.

Returns:

The value of the Notification property for this object.

assetCompositeModelId

public final String assetCompositeModelId()

The ID of the composite model that contains the asset property.

Returns:

The ID of the composite model that contains the asset property.

hasPath

public final boolean hasPath()

For responses, this returns true if the service returned a value for the Path property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

path

public final List<AssetPropertyPathSegment> path()

The structured path to the property from the root of the asset.

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 hasPath() method.

Returns:

The structured path to the property from the root of the asset.

externalId

public final String externalId()

The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

Returns:

The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

toBuilder

public AssetPropertySummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssetPropertySummary.Builder,AssetPropertySummary>

builder

public static AssetPropertySummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo