AssetModelPropertyDefinition (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AssetModelPropertyDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AssetModelPropertyDefinition()

Constructors
Constructor and Description
`AssetModelPropertyDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssetModelPropertyDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDataType()` The data type of the property definition.
`String`	`getDataTypeSpec()` The data type of the structure for this property.
`String`	`getExternalId()` An external ID to assign to the property definition.
`String`	`getId()` The ID to assign to the asset model property, if desired.
`String`	`getName()` The name of the property definition.
`PropertyType`	`getType()` The property definition type (see `PropertyType`).
`String`	`getUnit()` The unit of the property definition, such as `Newtons` or `RPM`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDataType(String dataType)` The data type of the property definition.
`void`	`setDataTypeSpec(String dataTypeSpec)` The data type of the structure for this property.
`void`	`setExternalId(String externalId)` An external ID to assign to the property definition.
`void`	`setId(String id)` The ID to assign to the asset model property, if desired.
`void`	`setName(String name)` The name of the property definition.
`void`	`setType(PropertyType type)` The property definition type (see `PropertyType`).
`void`	`setUnit(String unit)` The unit of the property definition, such as `Newtons` or `RPM`.
`String`	`toString()` Returns a string representation of this object.
`AssetModelPropertyDefinition`	`withDataType(PropertyDataType dataType)` The data type of the property definition.
`AssetModelPropertyDefinition`	`withDataType(String dataType)` The data type of the property definition.
`AssetModelPropertyDefinition`	`withDataTypeSpec(String dataTypeSpec)` The data type of the structure for this property.
`AssetModelPropertyDefinition`	`withExternalId(String externalId)` An external ID to assign to the property definition.
`AssetModelPropertyDefinition`	`withId(String id)` The ID to assign to the asset model property, if desired.
`AssetModelPropertyDefinition`	`withName(String name)` The name of the property definition.
`AssetModelPropertyDefinition`	`withType(PropertyType type)` The property definition type (see `PropertyType`).
`AssetModelPropertyDefinition`	`withUnit(String unit)` The unit of the property definition, such as `Newtons` or `RPM`.

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

- Constructor Detail
  - AssetModelPropertyDefinition
```
public AssetModelPropertyDefinition()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the property definition.
    
    Parameters:
    
    name - The name of the property definition.
  - getName
```
public String getName()
```
    The name of the property definition.
    
    Returns:
    
    The name of the property definition.
  - withName
```
public AssetModelPropertyDefinition withName(String name)
```
    The name of the property definition.
    
    Parameters:
    
    name - The name of the property definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataType
```
public void setDataType(String dataType)
```
    The data type of the property definition.
    
    If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
    
    Parameters:
    
    dataType - The data type of the property definition.
    
    If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
    
    See Also:
    
    PropertyDataType
  - getDataType
```
public String getDataType()
```
    The data type of the property definition.
    
    If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
    
    Returns:
    
    The data type of the property definition.
    
    If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
    
    See Also:
    
    PropertyDataType
  - withDataType
```
public AssetModelPropertyDefinition withDataType(String dataType)
```
    The data type of the property definition.
    
    If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
    
    Parameters:
    
    dataType - The data type of the property definition.
    
    If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropertyDataType
  - withDataType
```
public AssetModelPropertyDefinition withDataType(PropertyDataType dataType)
```
    The data type of the property definition.
    
    If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
    
    Parameters:
    
    dataType - The data type of the property definition.
    
    If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropertyDataType
  - setDataTypeSpec
```
public void setDataTypeSpec(String dataTypeSpec)
```
    The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
    
    The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
    
    Parameters:
    
    dataTypeSpec - The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
    
    The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
  - getDataTypeSpec
```
public String getDataTypeSpec()
```
    The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
    
    The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
    
    Returns:
    
    The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
    
    The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
  - withDataTypeSpec
```
public AssetModelPropertyDefinition withDataTypeSpec(String dataTypeSpec)
```
    The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
    
    The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
    
    Parameters:
    
    dataTypeSpec - The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
    
    The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnit
```
public void setUnit(String unit)
```
    The unit of the property definition, such as Newtons or RPM.
    
    Parameters:
    
    unit - The unit of the property definition, such as Newtons or RPM.
  - getUnit
```
public String getUnit()
```
    The unit of the property definition, such as Newtons or RPM.
    
    Returns:
    
    The unit of the property definition, such as Newtons or RPM.
  - withUnit
```
public AssetModelPropertyDefinition withUnit(String unit)
```
    The unit of the property definition, such as Newtons or RPM.
    
    Parameters:
    
    unit - The unit of the property definition, such as Newtons or RPM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(PropertyType type)
```
    The property definition type (see PropertyType). You can only specify one type in a property definition.
    
    Parameters:
    
    type - The property definition type (see PropertyType). You can only specify one type in a property definition.
  - getType
```
public PropertyType getType()
```
    The property definition type (see PropertyType). You can only specify one type in a property definition.
    
    Returns:
    
    The property definition type (see PropertyType). You can only specify one type in a property definition.
  - withType
```
public AssetModelPropertyDefinition withType(PropertyType type)
```
    The property definition type (see PropertyType). You can only specify one type in a property definition.
    
    Parameters:
    
    type - The property definition type (see PropertyType). You can only specify one type in a property definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
    
    Parameters:
    
    id - The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
  - getId
```
public String getId()
```
    The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
    
    Returns:
    
    The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
  - withId
```
public AssetModelPropertyDefinition withId(String id)
```
    The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
    
    Parameters:
    
    id - The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExternalId
```
public void setExternalId(String externalId)
```
    An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
    
    Parameters:
    
    externalId - An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
  - getExternalId
```
public String getExternalId()
```
    An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
    
    Returns:
    
    An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
  - withExternalId
```
public AssetModelPropertyDefinition withExternalId(String externalId)
```
    An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
    
    Parameters:
    
    externalId - An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. 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 AssetModelPropertyDefinition 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.780

Class AssetModelPropertyDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssetModelPropertyDefinition

Method Detail

setName

getName

withName

setDataType

getDataType

withDataType

withDataType

setDataTypeSpec

getDataTypeSpec

withDataTypeSpec

setUnit

getUnit

withUnit

setType

getType

withType

setId

getId

withId

setExternalId

getExternalId

withExternalId

toString

equals

hashCode

clone

marshall