java.lang.Object
- software.amazon.awssdk.services.iotsitewise.model.Property

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Property.Builder,Property>

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

Contains asset property information.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Property.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`).
`static Property.Builder`	`builder()`
`PropertyDataType`	`dataType()`	The property data type.
`String`	`dataTypeAsString()`	The property data type.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`externalId()`	The external ID of the asset 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 asset property.
`String`	`name()`	The name of the property.
`PropertyNotification`	`notification()`	The asset property's notification topic and state.
`List<AssetPropertyPathSegment>`	`path()`	The structured path to the property from the root of the asset.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Property.Builder>`	`serializableBuilderClass()`
`Property.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`PropertyType`	`type()`	The property type (see `PropertyType`).
`String`	`unit()`	The unit (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 asset property.
    
    Returns:
    
    The ID of the asset property.
  - name
```
public final String name()
```
    The name of the property.
    
    Returns:
    
    The name 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.
  - notification
```
public final PropertyNotification notification()
```
    The asset property's notification topic and state. For more information, see UpdateAssetProperty.
    
    Returns:
    
    The asset property's notification topic and state. For more information, see UpdateAssetProperty.
  - dataType
```
public final PropertyDataType dataType()
```
    The property data type.
    
    If the service returns an enum value that is not available in the current SDK version, dataType will return PropertyDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().
    
    Returns:
    
    The property data type.
    
    See Also:
    
    PropertyDataType
  - dataTypeAsString
```
public final String dataTypeAsString()
```
    The property data type.
    
    If the service returns an enum value that is not available in the current SDK version, dataType will return PropertyDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().
    
    Returns:
    
    The property data type.
    
    See Also:
    
    PropertyDataType
  - unit
```
public final String unit()
```
    The unit (such as Newtons or RPM) of the asset property.
    
    Returns:
    
    The unit (such as Newtons or RPM) of the asset property.
  - type
```
public final PropertyType type()
```
    The property type (see PropertyType). A property contains one type.
    
    Returns:
    
    The property type (see PropertyType). A property contains one type.
  - 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 asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
    
    Returns:
    
    The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
  - toBuilder
```
public Property.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Property.Builder,Property>
  - builder
```
public static Property.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Property.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

Class Property

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

name

alias

notification

dataType

dataTypeAsString

unit

type

hasPath

path

externalId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields