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

Interface AssetModelPropertyDefinition.Builder

    • Method Detail

      • name

        AssetModelPropertyDefinition.Builder name​(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.

      • dataType

        AssetModelPropertyDefinition.Builder dataType​(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, PropertyDataType

      • dataType

        AssetModelPropertyDefinition.Builder dataType​(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, PropertyDataType

      • dataTypeSpec

        AssetModelPropertyDefinition.Builder dataTypeSpec​(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.

      • unit

        AssetModelPropertyDefinition.Builder unit​(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.

      • type

        AssetModelPropertyDefinition.Builder type​(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.

      • id

        AssetModelPropertyDefinition.Builder id​(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.

      • externalId

        AssetModelPropertyDefinition.Builder externalId​(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.