@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AssetModelProperty extends Object implements Serializable, Cloneable, StructuredPojo
Contains information about an asset model property.
Constructor and Description |
---|
AssetModelProperty() |
Modifier and Type | Method and Description |
---|---|
AssetModelProperty |
clone() |
boolean |
equals(Object obj) |
String |
getDataType()
The data type of the asset model property.
|
String |
getDataTypeSpec()
The data type of the structure for this property.
|
String |
getExternalId()
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation.
|
String |
getId()
The ID of the asset model property.
|
String |
getName()
The name of the asset model property.
|
List<AssetModelPropertyPathSegment> |
getPath()
The structured path to the property from the root of the asset model.
|
PropertyType |
getType()
The property type (see
PropertyType ). |
String |
getUnit()
The unit of the asset model property, 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 asset model property.
|
void |
setDataTypeSpec(String dataTypeSpec)
The data type of the structure for this property.
|
void |
setExternalId(String externalId)
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation.
|
void |
setId(String id)
The ID of the asset model property.
|
void |
setName(String name)
The name of the asset model property.
|
void |
setPath(Collection<AssetModelPropertyPathSegment> path)
The structured path to the property from the root of the asset model.
|
void |
setType(PropertyType type)
The property type (see
PropertyType ). |
void |
setUnit(String unit)
The unit of the asset model property, such as
Newtons or RPM . |
String |
toString()
Returns a string representation of this object.
|
AssetModelProperty |
withDataType(PropertyDataType dataType)
The data type of the asset model property.
|
AssetModelProperty |
withDataType(String dataType)
The data type of the asset model property.
|
AssetModelProperty |
withDataTypeSpec(String dataTypeSpec)
The data type of the structure for this property.
|
AssetModelProperty |
withExternalId(String externalId)
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation.
|
AssetModelProperty |
withId(String id)
The ID of the asset model property.
|
AssetModelProperty |
withName(String name)
The name of the asset model property.
|
AssetModelProperty |
withPath(AssetModelPropertyPathSegment... path)
The structured path to the property from the root of the asset model.
|
AssetModelProperty |
withPath(Collection<AssetModelPropertyPathSegment> path)
The structured path to the property from the root of the asset model.
|
AssetModelProperty |
withType(PropertyType type)
The property type (see
PropertyType ). |
AssetModelProperty |
withUnit(String unit)
The unit of the asset model property, such as
Newtons or RPM . |
public void setId(String id)
The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in
UUID format, or else externalId:
followed by the external ID, if it has one. For more information,
see
Referencing objects with external IDs in the IoT SiteWise User Guide.
id
- The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual
ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
public String getId()
The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in
UUID format, or else externalId:
followed by the external ID, if it has one. For more information,
see
Referencing objects with external IDs in the IoT SiteWise User Guide.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual
ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
public AssetModelProperty withId(String id)
The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in
UUID format, or else externalId:
followed by the external ID, if it has one. For more information,
see
Referencing objects with external IDs in the IoT SiteWise User Guide.
id
- The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual
ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more
information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
public void setName(String name)
The name of the asset model property.
name
- The name of the asset model property.public String getName()
The name of the asset model property.
public AssetModelProperty withName(String name)
The name of the asset model property.
name
- The name of the asset model property.public void setDataType(String dataType)
The data type of the asset model property.
dataType
- The data type of the asset model property.PropertyDataType
public String getDataType()
The data type of the asset model property.
PropertyDataType
public AssetModelProperty withDataType(String dataType)
The data type of the asset model property.
dataType
- The data type of the asset model property.PropertyDataType
public AssetModelProperty withDataType(PropertyDataType dataType)
The data type of the asset model property.
dataType
- The data type of the asset model property.PropertyDataType
public void setDataTypeSpec(String dataTypeSpec)
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type.
dataTypeSpec
- The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type.public String getDataTypeSpec()
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type.
STRUCT
data type.public AssetModelProperty withDataTypeSpec(String dataTypeSpec)
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type.
dataTypeSpec
- The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type.public void setUnit(String unit)
The unit of the asset model property, such as Newtons
or RPM
.
unit
- The unit of the asset model property, such as Newtons
or RPM
.public String getUnit()
The unit of the asset model property, such as Newtons
or RPM
.
Newtons
or RPM
.public AssetModelProperty withUnit(String unit)
The unit of the asset model property, such as Newtons
or RPM
.
unit
- The unit of the asset model property, such as Newtons
or RPM
.public void setType(PropertyType type)
The property type (see PropertyType
).
type
- The property type (see PropertyType
).public PropertyType getType()
The property type (see PropertyType
).
PropertyType
).public AssetModelProperty withType(PropertyType type)
The property type (see PropertyType
).
type
- The property type (see PropertyType
).public List<AssetModelPropertyPathSegment> getPath()
The structured path to the property from the root of the asset model.
public void setPath(Collection<AssetModelPropertyPathSegment> path)
The structured path to the property from the root of the asset model.
path
- The structured path to the property from the root of the asset model.public AssetModelProperty withPath(AssetModelPropertyPathSegment... path)
The structured path to the property from the root of the asset model.
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.
path
- The structured path to the property from the root of the asset model.public AssetModelProperty withPath(Collection<AssetModelPropertyPathSegment> path)
The structured path to the property from the root of the asset model.
path
- The structured path to the property from the root of the asset model.public void setExternalId(String externalId)
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
externalId
- The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call
to
UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more
information, see Using
external IDs in the IoT SiteWise User Guide.public String getExternalId()
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
public AssetModelProperty withExternalId(String externalId)
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
externalId
- The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call
to
UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more
information, see Using
external IDs in the IoT SiteWise User Guide.public String toString()
toString
in class Object
Object.toString()
public AssetModelProperty clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.