Property (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotsitewise.model.Property

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Property
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains asset property information.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Property()

Constructors
Constructor and Description
`Property()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Property`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAlias()` The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature`).
`String`	`getDataType()` The property data type.
`String`	`getExternalId()` The external ID of the asset property.
`String`	`getId()` The ID of the asset property.
`String`	`getName()` The name of the property.
`PropertyNotification`	`getNotification()` The asset property's notification topic and state.
`List<AssetPropertyPathSegment>`	`getPath()` The structured path to the property from the root of the asset.
`PropertyType`	`getType()` The property type (see `PropertyType`).
`String`	`getUnit()` The unit (such as `Newtons` or `RPM`) of the asset property.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAlias(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`).
`void`	`setDataType(String dataType)` The property data type.
`void`	`setExternalId(String externalId)` The external ID of the asset property.
`void`	`setId(String id)` The ID of the asset property.
`void`	`setName(String name)` The name of the property.
`void`	`setNotification(PropertyNotification notification)` The asset property's notification topic and state.
`void`	`setPath(Collection<AssetPropertyPathSegment> path)` The structured path to the property from the root of the asset.
`void`	`setType(PropertyType type)` The property type (see `PropertyType`).
`void`	`setUnit(String unit)` The unit (such as `Newtons` or `RPM`) of the asset property.
`String`	`toString()` Returns a string representation of this object.
`Property`	`withAlias(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`).
`Property`	`withDataType(PropertyDataType dataType)` The property data type.
`Property`	`withDataType(String dataType)` The property data type.
`Property`	`withExternalId(String externalId)` The external ID of the asset property.
`Property`	`withId(String id)` The ID of the asset property.
`Property`	`withName(String name)` The name of the property.
`Property`	`withNotification(PropertyNotification notification)` The asset property's notification topic and state.
`Property`	`withPath(AssetPropertyPathSegment... path)` The structured path to the property from the root of the asset.
`Property`	`withPath(Collection<AssetPropertyPathSegment> path)` The structured path to the property from the root of the asset.
`Property`	`withType(PropertyType type)` The property type (see `PropertyType`).
`Property`	`withUnit(String unit)` The unit (such as `Newtons` or `RPM`) of the asset property.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Property
```
public Property()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The ID of the asset property.
    
    Parameters:
    
    id - The ID of the asset property.
  - getId
```
public String getId()
```
    The ID of the asset property.
    
    Returns:
    
    The ID of the asset property.
  - withId
```
public Property withId(String id)
```
    The ID of the asset property.
    
    Parameters:
    
    id - The ID of the asset property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the property.
    
    Parameters:
    
    name - The name of the property.
  - getName
```
public String getName()
```
    The name of the property.
    
    Returns:
    
    The name of the property.
  - withName
```
public Property withName(String name)
```
    The name of the property.
    
    Parameters:
    
    name - The name of the property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAlias
```
public void setAlias(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.
    
    Parameters:
    
    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.
  - getAlias
```
public String getAlias()
```
    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.
  - withAlias
```
public Property withAlias(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotification
```
public void setNotification(PropertyNotification notification)
```
    The asset property's notification topic and state. For more information, see UpdateAssetProperty.
    
    Parameters:
    
    notification - The asset property's notification topic and state. For more information, see UpdateAssetProperty.
  - getNotification
```
public PropertyNotification getNotification()
```
    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.
  - withNotification
```
public Property withNotification(PropertyNotification notification)
```
    The asset property's notification topic and state. For more information, see UpdateAssetProperty.
    
    Parameters:
    
    notification - The asset property's notification topic and state. For more information, see UpdateAssetProperty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataType
```
public void setDataType(String dataType)
```
    The property data type.
    
    Parameters:
    
    dataType - The property data type.
    
    See Also:
    
    PropertyDataType
  - getDataType
```
public String getDataType()
```
    The property data type.
    
    Returns:
    
    The property data type.
    
    See Also:
    
    PropertyDataType
  - withDataType
```
public Property withDataType(String dataType)
```
    The property data type.
    
    Parameters:
    
    dataType - The property data type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropertyDataType
  - withDataType
```
public Property withDataType(PropertyDataType dataType)
```
    The property data type.
    
    Parameters:
    
    dataType - The property data type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropertyDataType
  - setUnit
```
public void setUnit(String unit)
```
    The unit (such as Newtons or RPM) of the asset property.
    
    Parameters:
    
    unit - The unit (such as Newtons or RPM) of the asset property.
  - getUnit
```
public String getUnit()
```
    The unit (such as Newtons or RPM) of the asset property.
    
    Returns:
    
    The unit (such as Newtons or RPM) of the asset property.
  - withUnit
```
public Property withUnit(String unit)
```
    The unit (such as Newtons or RPM) of the asset property.
    
    Parameters:
    
    unit - The unit (such as Newtons or RPM) of the asset property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(PropertyType type)
```
    The property type (see PropertyType). A property contains one type.
    
    Parameters:
    
    type - The property type (see PropertyType). A property contains one type.
  - getType
```
public PropertyType getType()
```
    The property type (see PropertyType). A property contains one type.
    
    Returns:
    
    The property type (see PropertyType). A property contains one type.
  - withType
```
public Property withType(PropertyType type)
```
    The property type (see PropertyType). A property contains one type.
    
    Parameters:
    
    type - The property type (see PropertyType). A property contains one type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPath
```
public List<AssetPropertyPathSegment> getPath()
```
    The structured path to the property from the root of the asset.
    
    Returns:
    
    The structured path to the property from the root of the asset.
  - setPath
```
public void setPath(Collection<AssetPropertyPathSegment> path)
```
    The structured path to the property from the root of the asset.
    
    Parameters:
    
    path - The structured path to the property from the root of the asset.
  - withPath
```
public Property withPath(AssetPropertyPathSegment... path)
```
    The structured path to the property from the root of the asset.
    
    NOTE: This method appends the values to the existing list (if any). Use setPath(java.util.Collection) or withPath(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    path - The structured path to the property from the root of the asset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPath
```
public Property withPath(Collection<AssetPropertyPathSegment> path)
```
    The structured path to the property from the root of the asset.
    
    Parameters:
    
    path - The structured path to the property from the root of the asset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExternalId
```
public void setExternalId(String externalId)
```
    The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
    
    Parameters:
    
    externalId - The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
  - getExternalId
```
public String getExternalId()
```
    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.
  - withExternalId
```
public Property withExternalId(String externalId)
```
    The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
    
    Parameters:
    
    externalId - The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Property clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class Property

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Property

Method Detail

setId

getId

withId

setName

getName

withName

setAlias

getAlias

withAlias

setNotification

getNotification

withNotification

setDataType

getDataType

withDataType

withDataType

setUnit

getUnit

withUnit

setType

getType

withType

getPath

setPath

withPath

withPath

setExternalId

getExternalId

withExternalId

toString

equals

hashCode

clone

marshall